Metadata-Version: 2.4
Name: lorax-arg
Version: 0.1.4
Summary: Interactive ARG visualization for genomics
Author: Lorax Team
License: MIT
Project-URL: Homepage, https://lorax.in
Project-URL: Documentation, https://lorax.in
Project-URL: Source, https://github.com/pratikkatte/lorax
Project-URL: Issues, https://github.com/pratikkatte/lorax/issues
Keywords: lorax,arg,ancestral recombination graph,tree sequence,visualization,genomics,evolution,phylogenetics,bioinformatics
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Environment :: Console
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastapi>=0.100.0
Requires-Dist: uvicorn>=0.20.0
Requires-Dist: python-socketio>=5.0.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: click>=8.0.0
Requires-Dist: aiofiles>=24.0.0
Requires-Dist: aiohttp>=3.0.0
Requires-Dist: numpy>=2.0.0
Requires-Dist: pandas>=2.0.0
Requires-Dist: pyarrow>=18.0.0
Requires-Dist: tskit>=1.0.0
Requires-Dist: tszip>=0.2.0
Requires-Dist: redis>=5.0.0
Requires-Dist: google-cloud-storage>=3.0.0
Requires-Dist: starlette>=0.40.0
Requires-Dist: psutil>=5.0.0
Requires-Dist: ete3>=3.1.0
Requires-Dist: numba>0.57.1
Requires-Dist: python-multipart>=0.0.10
Provides-Extra: prod
Requires-Dist: gunicorn>=23.0.0; extra == "prod"
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: httpx>=0.24.0; extra == "dev"
Requires-Dist: locust>=2.15.0; extra == "dev"
Requires-Dist: python-socketio[client]>=5.0.0; extra == "dev"
Requires-Dist: msprime>=1.2.0; extra == "dev"
Dynamic: license-file

# Lorax

Lorax is a web-native platform for real-time, interactive visualization and exploration of population-scale Ancestral Recombination Graphs.

- CLI entrypoint: `lorax` (alias: `lorax-arg`)

![Lorax demo](https://raw.githubusercontent.com/pratikkatte/lorax/main/docs/images/lorax-demo.gif)

## Key features
- Scalable rendering: interactive visualization of ARGs at a biobank scale.
- Genome-wide navigation: Traverse genomic coordinates and inspect local genealogies at recombination breakpoints.
- Mutation-aware: Trace variant inheritance through local genealogies
- Metadata integration: Filter, color, and subset samples by population labels, phenotypes, or custom annotations.
- Flexible inputs: Supports .trees, .trees.tsz (tskit tree sequences), and CSV-based ARG representations

## Quick start (pip)

```bash
pip install lorax-arg
lorax # this opens lorax in a browser

lorax --file # to directly load file on lorax (preferred for large files.)
```
Input Formats
Tree sequences: .trees and .trees.tsz files (compatible with tskit/tsinfer/tsdate, Relate, ARGweaver output)
CSV: One row per recombination interval with columns for genomic position, Newick tree string, tree depth, and optional metadata. Ideal for custom inference pipelines or non-model organisms.

## Use Cases
- Explore signatures of natural selection in local genealogies.
- Visualize introgression and admixture across genomic regions. 
- Trace ancestry of specific samples through population-scale ARGs
- Navigate from GWAS hits or functional annotations to underlying genealogical structure

## Links
Web platform: https://lorax.ucsc.edu
Source code: https://github.com/pratikkatte/lorax


