Skip to content

Getting Started

Welcome to LZGraphs! This section will help you get up and running quickly with the library.

What is LZGraphs?

LZGraphs is a Python library that uses the Lempel-Ziv 76 (LZ76) compression algorithm to create graph representations of T-cell receptor (TCR) repertoires. These graphs capture the statistical properties of CDR3 sequences, enabling:

  • Probability estimation - Calculate the generation probability of any sequence
  • Sequence generation - Generate new sequences following repertoire statistics
  • Diversity analysis - Measure repertoire complexity using novel metrics
  • Comparison - Compare repertoires using graph-based divergence measures

Installation

Install LZGraphs and its dependencies

Quick Start

Build your first graph in 5 minutes

First Steps

Understand the basics and choose the right graph type

Prerequisites

Before using LZGraphs, you should have:

  • Python 3.9 or higher installed
  • Basic familiarity with pandas DataFrames
  • Understanding of TCR/CDR3 sequences (helpful but not required)

Next Steps

After completing the Getting Started guide, explore:

  • Tutorials - Detailed walkthroughs of common tasks
  • Concepts - Understand the theory behind LZGraphs
  • API Reference - Complete documentation of all classes and functions