Installation¶
citoolkit
is writtin in Python 3, and requires Python 3.9. It is available as a PyPi package and can be installed by running:
$ pip install citoolkit
If you want to modify citoolkit
, access the test suite, or run the included examples/experiments you can use [Poetry](https://python-poetry.org/ “Poetry”). First install Poetry and optionally activate the virtual environment in which you would like to run citoolkit
. Then navigate to the citoolkit
root directory and run:
$ poetry install
Alternatively, to automatically install citoolkit
and all its dependencies in a virtual environment, navigate to the citoolkit
root directory and run:
$ make create_env
You can then activate that virtual environment by running:
$ make enter_env