Contributing

Ribasim welcomes contributions.

There is developer documentation for the Julia core, the Basic Model Interface (BMI), Python tooling, and the QGIS plugin. A guide on how to add a new node type to both is written in adding node types. Release process describes the steps to follow when creating a new Ribasim release.

1 Setting up the developer environment

1.1 Clone Ribasim

In order to have the Ribasim repository locally available, you can clone it with Git. Git can be installed from git-scm.com. Once installed, run the following command at a directory of your choice:

In order to have the Ribasim repository locally available, run the following command at a directory of your choice:

git clone https://github.com/Deltares/Ribasim.git

To continue with the following steps, make the root of the repository your working directory by running

cd Ribasim

1.2 Setting up pixi

First, set up pixi as described on their getting started page.

Then set up the environment by running the following commands:

pixi run install

This will automatically install all required packages for development. Our pixi environment also provides an instance of Julia and QGIS. These will not conflict with any pre-installed applications, as long as you have the pixi environment enabled. You can do this in a terminal by calling pixi shell, or starting programs with pixi run julia, or pixi run qgis. Visual Studio Code will locate the pixi environments; select ('default': Pixi) once such that all developer tools are available. Unless the setting python.terminal.activateEnvironment is disabled, it will already activate the environment in your terminal.