Metadata-Version: 2.4
Name: tscompare
Version: 0.2.1
Summary: Tools for comparing tree sequences.
Author-email: Tskit Developers <admin@tskit.dev>
Maintainer-email: Tskit Developers <admin@tskit.dev>
License: MIT
Project-URL: Homepage, https://tskit.dev/tscompare
Project-URL: Bug Tracker, https://github.com/tskit-dev/tscompare/issues
Project-URL: Documentation, https://tskit.dev/tscompare/docs/
Project-URL: Source Code, https://github.com/tskit-dev/tscompare
Keywords: population genetics,tree sequence,tskit
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: tskit>=1.0.0
Requires-Dist: scipy>=1.7.0
Dynamic: license-file

# tscompare

[![License](https://img.shields.io/github/license/tskit-dev/tscompare)](https://github.com/tskit-dev/tscompare/blob/main/LICENSE) [![PyPI version](https://img.shields.io/pypi/v/tscompare.svg)](https://pypi.org/project/tscompare/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/tscompare.svg)](https://pypi.org/project/tscompare/) [![Docs Build](https://github.com/tskit-dev/tscompare/actions/workflows/docs.yml/badge.svg)](https://github.com/tskit-dev/tscompare/actions/workflows/docs.yml) [![Tests](https://github.com/tskit-dev/tscompare/actions/workflows/tests.yml/badge.svg)](https://github.com/tskit-dev/tscompare/actions/workflows/tests.yml)

Utilities for comparing Ancestral Recombination Graphs (ARGs) represented as tree sequences. Provides tooling to quantify similarities and differences between ARG topologies, haplotype paths, and related structures. At present, this repository implements the methods described in
[Fritze et al., "A forest is more than its trees: haplotypes and ancestral recombination graphs"](https://doi.org/10.1101/2024.11.30.626138).

Documentation: https://tskit.dev/tscompare/docs/stable/ (latest: https://tskit.dev/tscompare/docs/latest/)

## Installation

Install from PyPI:

```
python -m pip install tscompare
```

See documentation for usage and examples: https://tskit.dev/tscompare/docs/stable/
