Contributing to sopa

Contributions are welcome as we aim to continue improving the pipeline. For instance, you can contribute by:

If you want to open a PR, follow the following instructions.

Installing `sopa` in editable mode

When contributing, installing sopa in editable mode is recommended. Also, we recommend installing the 'dev' extra.

For this, use one of the two following lines:

# with pip
pip install -e '.[dev]'

# or with poetry
poetry install -E dev

Use the black formatter and isort. Their usage should be automatic as they are in the pyproject.toml file. Depending on your IDE, you can choose to format your code on save.
Run flake8 inside the whole sopa directory, i.e. flake8 sopa
Follow the PEP8 style guide.
Provide meaningful names to all your variables and functions.
Document your functions and type your function inputs/outputs.
Try as much as possible to follow the same coding style as the rest of the repository.

To add some new code to sopa, you should:

Fork the repository
Install sopa in editable mode with the 'dev' extra (see above)
Create your personal branch from dev
Implement your changes
Create a pull request on the dev branch. Add explanations about your developed features, and wait for discussion and validation of your pull request