Installation¶

tspop is available on PyPi for installation with pip:

pip install tspop

If you absolutely must use the most up-to-date code, you can do it by cloning the git repository,

git clone https://github.com/gtsambos/tspop

navigating into the root directory,

cd tspop

and installing it like this:

pip install .

Developer installation¶

To install tspop in addition to the packages needed to develop and run tests, perform the first two steps above, then run the following command:

pip install -e .[dev]

I recommend developing tspop in a virtual environment like a [conda environment](https://conda.io/projects/conda/en/latest/index.html).

The test suite uses the [pytest](https://docs.pytest.org/en/7.2.x/) module.

pytest tests

You can run specific classes or tests in specific test files:

pytest tests/test_tspop.py::TestIbdSquash

To get printed output from the tests, use the s flag:

pytest -s tests/test_tspop.py::TestIbdSquash.test_basic

pytest tests/test_tspop.py::TestIbdSquash.test_basic

Note

Finish later.

cd docs
make clean
make html