Development

BANZAI-NRES is developed on GitHub and follows a standard open-source project contribution workflow. We follow a very similar workflow to Astropy which is documented here.

Testing

To run the unit tests locally run:

tox -e test

To run the code style checks run:

tox -e codestyle

To test building the documentation run:

tox -e build_docs

The package infrastructure is based on the Astropy Package Template so the tox testing infrastructure to test different versions of dependencies is provided by the template and documented there. You will need Pandoc: https://pandoc.org/installing.html

If you have issues package update errors with building the documentation, try forcing an update of the environment with:

rm -r .tox
tox -e test

Testing on Real Data

Generally, the simplest way to reduce data with BANZAI-NRES is to follow the example reduction on the next page. For more complex setups that use RabbitMQ and celery, see the helm chart of deployment details.