Development

Contributions are welcome. mf6rtm uses pixi for fast, reproducible development environments.

Setup

# Fork, then clone your fork
git clone https://github.com/YOUR-USERNAME/mf6rtm.git
cd mf6rtm

# Install the dev environment with all dependencies
pixi install

Common tasks

pixi run test          # run the test suite
pixi run test-cov      # run tests with coverage
pixi run lint          # run linting
pixi run -e py311 test  # test against a specific Python version

Building the docs

pip install -e ".[docs]"
sphinx-build -b html docs docs/_build/html

Contributing

1. Open an issue to discuss bugs or feature ideas.

2. Branch off develop, keep changes focused, and add tests where it makes sense.

3. Make sure pixi run test and pixi run lint pass, then open a pull request.