Contributing

Bug reports and feature requests are welcome, and can be made with the GitHub issue tracker.

Development

Setup

To create up a development setup, start by forking the repository, then clone the fork with:

git clone https://github.com/<username>/geedim
cd geedim

Dependencies required for running tests can be installed, and Geedim linked into your environment with:

pip install --group tests -e .

Pull requests

Make changes in a new branch and submit a pull request from your fork when the changes are ready for review. You can use a draft pull request to get early feedback on changes before they are complete. Geedim uses the GitHub Flow workflow.

Please include reStructuredText style docstrings and pytest unit tests with your code. Geedim uses Ruff for linting and formatting, with settings in pyproject.toml.