There are two basic options for installing
tskit: either through
pre-built binary packages using conda or
by compiling locally using pip. We recommend using
for most users, although
pip can be more convenient in certain cases.
Tskit is installed to provide succinct tree sequence functionality
to other software (such as msprime),
so it may already be installed if you use such software.
Tskit requires Python 3.4+. There are no external C library dependencies. Python
dependencies are installed automatically by
$ conda install -c conda-forge tskit
condausing miniconda. Make sure you follow the instructions to fully activate your
Set up the conda-forge channel using
conda config --add channels conda-forge.
conda install tskit.
Try it out:
There are several different ways to obtain
conda. Please see the
anaconda installation documentation
for full details.
pip is somewhat more flexible than
may result in code that is (slightly) faster on your specific hardware.
Pip is the recommended method when using the system provided Python
installations. Installation is straightforward:
$ python3 -m pip install tskit
For general use, we do not recommend installing development versions.
Occasionally pre-release versions are made available, which can be
python3 -m pip install --pre tskit. If you really need to install a
bleeding-edge version, see Installing development versions.