Contributing Guide

We are happy to receive any contributions! Please review the following material to learn how to contribute.

If you are new to GitHub or git, you may find this guide useful.

Setting up a development environment

First, fork the repository on GitHub, then clone your forked repository.

git clone https://github.com/your-username/BaSiCPy.git
cd BaSiCPy

Then, create a virtual environment and install the development version of the package.

python -m venv venv
source venv/bin/activate
pip install -e '.[dev]'

Install pre-commit to check code formatting.

pre-commit install