Dependencies

We use poetry to version dependencies and publish to PyPi.

Once you have poetry, you may initialize a new project by entering its root folder and running:

poetry init

Then you may add dependencies simple by running:

poetry add numpy

where numpy can be any dependency required.

Then, you may install the dependencies by:

poetry install

and build it :

poetry build

Finally, once a new version is ready, one may release it on PyPi by running:

poetry publish

Yet, credentials are required for the last step.

Notes on dependencies

We need seaborn at least 0.13.0 otherwise annotation in heatmaps fails.

python -m pip install seaborn==0.13.0

In case we need a requirements.txt file, we only have to run:

poetry export --without-hashes --format=requirements.txt > requirements.txt

ReadTheDocs

To test whether the documentation builder will perform online as we would like to, we may run locally the following command:

cd documentation_builder/
sphinx-build -b html -d _build/doctrees -D language=en . _build/html -v