QGIS plugin

1 Opening a model

This guide assumes you have already installed the Ribasim core and QGIS plugin as described in the install page.

Use any running Ribasim model to follow this guide. For ready-made example models download and unzip generated_testmodels.zip from the release assets, and use for instance the basic test model.

You can open a model by clicking on the Ribasim icon on the toolbar, selecting Open Ribasim model, and choosing a TOML file.

Alternatively, drag a TOML file into QGIS.

If the Ribasim icon on the toolbar is hidden, click View > Toolbars, and enable the Ribasim toolbar. The same options are also available under the Plugins menu.

2 Running a model

Click on the Ribasim icon on the toolbar, select Run Ribasim model.

This will run the simulation in the background, showing progress in the QGIS task manager and a live output dialog. When the simulation completes successfully, the model results are automatically reloaded.

QGIS resolves the Ribasim executable in this order:

  1. Set Ribasim home (Plugins → Ribasim → Set Ribasim home)
  2. RIBASIM_HOME
  3. PATH
  4. %LOCALAPPDATA%\Microsoft\WindowsApps (Windows)

See the install section for details.

3 Inspect a (large) model

For larger models the node tables can grow quite large. To facilitate inspection, the tables are linked via the node_id field to the Node table, and react to the selection of the Node layer. That is, on selection of certain nodes—either via the map or the attribute table—the selection is also made in all related tables. This is also the case for the Link layer. It helps to set the attribute table of a table of interest to show selected features only (using the dropdown button on the bottom left).

Selection change

4 Inspecting results

Click on the Ribasim icon on the toolbar, select Timeseries results.

This will open a plotting pane. If you have results, it will select the flow results by default. These are available on links. Select the Link layer.

Now select the links that you want to see the timeseries of. Whenever the selection changes, the plot updates. You can use to select multiple links, or ( on macOS) to toggle links on and off.

Per result file you can select one or more variables to plot. Note that Basin results are only available on Basins, which means you have to select the Node layer first, and then select the Basin nodes you wish to see.

Click the “Time Series” button of the iMOD plugin.

Select the layer that you wish to plot. From the “Node” layer you can plot level or storage on Basin nodes. From the “Link” layer you can plot flow over flow links. Note that before switching between these, you typically have to click “Clear” to clear the selection. If you run a simulation with the model open in QGIS, you have to close and re-open the “iMOD Time Series Plot” panel for the new results to be loaded.

Select the variables that you want to plot.

Click “Select points” and select a node by dragging a rectangle around it on the map. Hold the Ctrl key to select multiple nodes.

The associated time series are shown in the graph.

Only the basin.nc and flow.nc can be inspected with the “iMOD Time Series Plot” panel. All result files can be loaded as a layer by dragging the files onto QGIS. Right click the layer and select “Open Attribute Table” to view the contents.

5 Reloading models

If you made changes to your model outside of QGIS, and want to see the new version in QGIS, the quickest way is to click Reload Ribasim model. This reloads both the model and the results.

This avoids the need to remove the group and open the same model again via the plugin. It can be convenient when iteratively building your model via Python, or running new simulations.