Co-development with Ribasim

Ribasim-NL pins to a specific Ribasim version in pixi.toml. Generally this will be the latest release. During development sometimes you may want to test out the latest unreleased development version of Ribasim.

To do so, open pixi.toml in your editor. Find the [pypi-dependencies] section and change the ribasim git source:

[pypi-dependencies]
ribasim = { git = "https://github.com/Deltares/Ribasim", branch = "main", subdirectory = "python/ribasim" }

You can change the branch name if needed, or use a specific commit with rev = "0075d4a".

If you are making changes to the Ribasim repository yourself, it will be more convenient to point to a local clone rather than GitHub. This can be done using this syntax:

[pypi-dependencies]
ribasim = { path = "../Ribasim/python/ribasim", editable = true }

This path will work if you clone Ribasim next to Ribasim-NL.

After you are done modifying pixi.toml, run pixi install to ensure the dependencies are installed.

The Ribasim core binary is installed separately by pixi run install-core, see scripts/install_ribasim_core.py. Make sure its version is compatible with the Ribasim Python package.

For Ribasim developer documentation see ribasim.org/dev.