Contributor Guide

pynsitu is meant to be a community driven package and we welcome feedback and contributions.

Did you notice a bug? Are you missing a feature? A good first starting place is to open an issue in the github issues page.

In order to contribute to pynsitu, please fork the repository and submit a pull request. A good step by step tutorial for this can be found in the xarray contributor guide.

Environments

The easiest way to start developing pynsitu pull requests, is to install one of the conda environments provided in the ci folder:

conda env create -f ci/environment-dev-310.yml

Activate the environment with:

conda activate insitu_dev

Code Formatting

We use black as code formatter and pull request will fail in the CI if not properly formatted.

All conda environments contain black and you can reformat code using:

black src/pynsitu

Running the test suite

The tests can then be run directly inside your Git clone (without having to install pynsitu) by typing:

pytest tests