Installation

These are some variables that should be set prior to running the tests.

# Ensure that you are using local python packages
export PYTHONNOUSERSITE=True

Note

In order to run this program you will need to create a custom environment. This assumes you are using Anaconda.

conda create -n syndeo python=3.10
conda activate syndeo
pip install poetry # ensure your version is >= 1.4.2
poetry install # add --with=dev if you want developer tests

Tip

If you would rather use the pip installer executing the following instead.

pip install .

Documentation

To generate the full documentation use Sphinx ^{1 1}This will generate a index.html under docs/build/index.html..

nox -rs show_sphinx

Footnotes