Skip to content

Installation

Adam English edited this page Oct 1, 2021 · 10 revisions

Recommended

For stable versions of Truvari, use pip

python3 -m pip install truvari

Specific versions can be installed via

python3 -m pip install truvari==3.0.0

See pypi for a history of all distributed releases.

Manual Installation

To build Truvari directly, clone the repository and switch to a specific tag.

git clone https://github.com/spiralgenetics/truvari.git
git checkout tags/v3.0.0
python3 setup.py install

To see a list of all available tags, run:

git tag -l

If you have an older clone of the repository, but don't see the version you're looking for in tags, make sure to pull the latest changes:

git pull
git fetch --all --tags

Building from develop

The default branch is develop, which holds in-development changes. This is for developers or those wishing to try experimental features and is not recommended for production. Development is versioned higher than the most recent stable release with an added suffix (e.g. Current stable release is 3.0.0, develop holds 3.1.0-dev). If you'd like to install develop, repeat the steps above but without git checkout tags/v3.0.0. See wiki for details on how branching is handled.

Docker

See Development for details on building a docker container.

Clone this wiki locally