Development

Changelog

View the changelog for each PyPARRM version here: version changelog

Installing PyPARRM in editable mode

If you want to make changes to PyPARRM, you may wish to install it in editable mode. To do so, first clone the GitHub repository to your desired location. Once cloned, navigate to this location and install the package alongside its development requirements using pip:

$ pip install -e .
$ pip install -r requirements_dev.txt

Contributing to PyPARRM

If you encounter any issues with the package or wish to suggest improvements, please submit a report on the issues page.

If you have made any changes which you would like to see officially added to the package, consider submitting a pull request. When submitting a pull request, please check that the existing test suite passes, and if you add new features, please make sure that these are covered in the unit tests. The tests can be run by navigating to the /tests directory and calling pytest:

$ pytest test_parrm.py

Please also check that the documentation can be built following any changes, which can be done using Sphinx in the /docs directory:

$ make html

Finally, features of the code such as compliance with established styles and spelling errors in the documentation are also checked. Please ensure that the code is formatted using Black, and check that there are no egregious errors from the following commands:

$ pycodestyle
$ pydocstyle
$ codespell