Contributing

earthkit-hydro is an open-source project, and contributions are highly welcomed and appreciated.

The code is hosted on GitHub.

Development workflow

  1. Fork the repository on GitHub

  2. Clone the fork to your local machine

  3. Create a virtual environment and install the package in development mode

  4. Create a new branch for your changes

  5. Make your changes and commit them with a clear message

  6. Run tests to ensure everything is working correctly

  7. Push your changes to your fork on GitHub

  8. Open a pull request against the develop branch of the main repository

Code style

This project uses ruff, black, isort and flake8 for code styling and formatting. To handle these automatically, you can use pre-commit hooks. To set them up, run:

pip install pre-commit
pre-commit install

Testing

To run the tests, you can use pytest. Make sure you have all dependencies installed, then simply run:

pytest