Contributing

Pull requests and issues are welcome! For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests and docs as appropriate.

Developer setup

git clone https://github.com/Oxid15/cascade.git

Use Python one version behind the latest as recommended. Remember to create a venv!

python -m venv ./venv
source ./venv/bin/activate

cd cascade
pip install -e .

Install requirements

pip install -r cascade/tests/requirements.txt

Run all tests

cd cascade/tests
pytest

Install requirements

pip install -r cascade/docs/requirements.txt

Build the docs

cd cascade/docs
sphinx-build source build

Format of docstrings is numpy.

Cascade uses flake8, black and isort. Be sure that flake8 passes before pushing the code.

Each file should have license notice in the header - be sure it is included.