Dependencies can be installed with poetry by running
poetry installThis will initialise a virtual environment,.venv in
the project root (this behaviour can be modified in
the poetry.toml file). This environment
can then be activated with
source .venv/bin/activateCommon development tasks can be run using taskipy. The full list of available tasks can be seen using.
task --listPre-commit hooks can be installed by running
pre-commit installLinting checks can then be run using
task lintTests can be run with
task testDocs can be built using Sphinx by running
task docsBuilt docs will be generated in the docs/build folder.
Likewise, documentation tests can be run with
task doc-testsBuilding documentation also automatically builds API documentation from docstrings. Docstrings should be written using the Numpy format. Types should be documented using typehints not in the docstring.