CONTRIBUTING.md

Contribution guide

Thanks for wanting to help out!

Please follow the code of conduct.

Development environment set-up

pip install -e .

Testing

Run the example from the README and make sure the output looks correct.

Building documentation

make -C docs

Building package

pip install build
pyproject-build

Submitting changes

Make sure the above test is successful, then make a pull-request on GitHub.