Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make also sure to update tests as appropriate.
To easily install all the (dev) dependencies use poetry:
poetry install
Some useful Make commands which can be used during development:
clean Remove all pycache, coverage, ... files in project folder.
format Run isort and black to autoformat python files.
check Run isort, black, flake8 and mypy to perform checks.
test Run pytest for unit and integration testing located in tests folder.
install Install the package and (dev) dependencies.
docs Create docs.
Note that the docs command can only be used in the poetry environment.
Example to clean project folder:
make clean
Note that we aim to adhere to the PEP8 and the numpydoc style guides.