Development

Changelog

View the changelog for each PyBispectra version here: version changelog

Installing PyBispectra in editable mode

If you want to make changes to PyBispectra, 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 .[dev]

Contributing to PyBispectra

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. A unit test suite is included. Tests must be added for any new features, and adaptations to the existing tests must be made where necessary. Checks for these tests are run when a pull request is submitted, however these tests can also be run locally by calling coverage with pytest in the base directory:

coverage run && coverage report

Please also check that the documentation can be built following any changes. The documentation is built when a pull request is submitted, however the documentation can also be built locally using Sphinx in the /docs directory (outputs are in the /docs/build/html directory):

make html

Finally, features of the code such as compliance with established styles and spelling errors in the documentation are also checked. These checks are run when a pull request is submitted, however they can also be run locally using pre-commit. To have these checks run automatically whenever you commit changes, install pre-commit with the following command in the base directory:

pre-commit install