Skip to content

Learn LZGraphs

Whether you're new to the library or looking to deepen your understanding, start here.


New to LZGraphs?

Follow this path:

1. Install

pip install LZGraphs — requirements and troubleshooting.

2. Quick Start

Build a graph, score sequences, simulate, and measure diversity in 5 minutes.

3. First Steps

Understand graph variants (AAP, NDP, Naive) and choose the right one for your data.


Tutorials

In-depth walkthroughs that build intuition for how LZGraphs works and what the numbers mean.

Tutorial What you'll learn Time
Graph Construction Build graphs, explore nodes/edges, add gene data and abundances 15 min
Sequence Analysis Score with LZPGEN, simulate, perplexity, gene-constrained generation 20 min
Diversity Metrics Hill numbers, richness curves, PGEN distributions, JSD comparisons 15 min

Examples

Copy-paste ready code for common tasks: Examples Gallery


Prerequisites

  • Python 3.9+ and NumPy (installed automatically)
  • Basic Python knowledge (lists, dicts, loops)
  • Some familiarity with CDR3 / TCR / BCR sequences is helpful but not required — the tutorials explain the biology as needed