Developer guide

This guide describes principles and workflows for developers.

Setup

We recommend programming in a fresh virtual environment. You can set up the conda environment and activate it

make conda-env
conda activate singd

If you don't use conda, set up your preferred environment and run

pip install -e ."[lint,test,doc]"

to install the package in editable mode, along with all required development dependencies (the quotes are for OS compatibility, see here).

Continuous integration

To standardize code style and enforce high quality, checks are carried out with Github actions when you push. You can also run them locally, as they are managed via make:

• Run tests with make test

• Run all linters with make lint, or separately with:

  • Run auto-formatting and import sorting with make black and make isort

  • Run linting with make flake8

  • Run docstring checks with make pydocstyle-check and make darglint-check

Documentation

We use the Google docstring convention and mkdocs which allows using markdown syntax in a docstring to achieve formatting.

To build the documentation, run

mkdocs serve

from the repository root and navigate to the displayed address.