.. tracts documentation master file, created by
   sphinx-quickstart on Wed Nov 19 12:38:28 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

tracts 2.0 documentation
========================

``tracts`` is a Python library used to model migration histories based on ancestry
tracts in admixed individuals. Time-dependent gene flow from multiple populations
can be modeled. In tracts 2.0, sex-biased migration and recombination rates are
supported, enabling modeling and inference for both autosomes and the X chromosome.

Installing ``tracts``
---------------------

To install:

1. Clone the repository.
2. Open a terminal inside your local copy.
3. Run ``pip install .``

You can now import ``tracts`` as a Python package.

``tracts`` is currently not distributed on PyPI or Conda.

Using ``tracts``
----------------

For detailed guidelines on how to use ``tracts`` in practice, see the
`README file <https://github.com/gravelLab/tracts>`_ in the GitHub repository.


.. toctree::
   :maxdepth: 4
   :caption: Contents:
   
   modules