Development

Writing Code

To create a development environment, you must have mamba installed.

A development conda environment can be created and activated with:

make env
mamba activate red

Some handy make commands are available:

make lint # Lint the codebase with Ruff
make format # Format the codebase with Ruff
make type-check # Type-check the codebase with Mypy
make test # Run the unit tests with Pytest

To serve the documentation locally:

mkdocs serve

Publishing

PyPI

There is a GitHub Actions workflow that will automatically publish to PyPI when a new tag is pushed:

git tag <new version>
git push origin <new version>