Tip

For an interactive online version click here: Binder badge

Update a Wflow model: gauging stations#

Once you have a Wflow model, you may want to update your model in order to use a new landuse map, change a parameter value, add sample locations, use different forcing data, create and run different scenarios etc.

With HydroMT, you can easily read your model and update one or several components of your model using the update function of the command line interface (CLI). Here are the steps and some examples on how to update/add gauging stations to your model.

All lines in this notebook which starts with ! are executed from the command line. Within the notebook environment the logging messages are shown after completion. You can also copy these lines and paste them in your shell to get more feedback.

Import packages#

In this notebook, we will use some functions of HydroMT to plot the new gauging stations of the updated model. Here are the libraries to import to realize these steps.

[1]:

import numpy as np
import hydromt

[2]:

# for plotting
import matplotlib.pyplot as plt
import cartopy.io.img_tiles as cimgt
import cartopy.crs as ccrs

proj = ccrs.PlateCarree()  # plot projection

Locations of the gauging stations#

Adding gauging stations to your Wflow model can be quite useful. It allows you to directly extract model outputs at specific locations. For example for model validation, calibration, you can then directly compare model results to available observations.

In our previous notebook, we built a wflow model in which the locations of the available GRDC stations are including. If you have other observation data available, you can easily add them to your model using HydroMT. One way to do it is to prepare a csv table containing the ID, latitude and longitude of the available stations. An example test_stations.csv has been prepared. Let’s have a look at it.

[3]:

fn_station = "test_stations.csv"
with open(fn_station, "r", encoding="utf8") as f:
    txt = f.read()
print(txt)

ID,Name,x,y,uparea
1001,Gauge1,11.9594,45.8925,3642
1002,Gauge2,12.3395,46.1492,2
1003,Gauge3,12.0785,46.1122,837

Here we can see that we have defined three stations with an ID and the longitude (x) and latitude (y) coordinates, in the same EPSG system as our model (EPSG 4326). We can now add them to our model.

HydroMT CLI update interface#

Using the HydroMT build API, we can update one or several components of an already existing Wflow model. Let’s get an overview of the available options:

[4]:

# Print the options available from the update command
! hydromt update --help

Usage: hydromt update [OPTIONS] MODEL MODEL_ROOT

  Update a specific component of a model.

  Set an output directory to copy the edited model to a new folder, otherwise
  maps are overwritten.

  Example usage: --------------

  Update (overwrite!) landuse-landcover based maps in a Wflow model: hydromt
  update wflow /path/to/model_root -c setup_lulcmaps --opt lulc_fn=vito -d
  /path/to/data_catalog.yml -v

  Update Wflow model components outlined in an .yml configuration file and
  write the model to a directory: hydromt update wflow /path/to/model_root  -o
  /path/to/model_out  -i /path/to/wflow_config.yml  -d
  /path/to/data_catalog.yml -v

Options:
  -o, --model-out DIRECTORY  Output model folder. Maps in MODEL_ROOT are
                             overwritten if left empty.
  -i, --config PATH          Path to hydroMT configuration file, for the model
                             specific implementation.
  -c, --components TEXT      Model methods from configuration file to run
  --opt TEXT                 Method specific keyword arguments, see the method
                             documentation of the specific model for more
                             information about the arguments.
  -d, --data TEXT            Path to local yaml data catalog file OR name of
                             predefined data catalog.
  --dd, --deltares-data      Flag: Shortcut to add the "deltares_data" catalog
  --fo, --force-overwrite    Flag: If provided overwrite existing model files
  --cache                    Flag: If provided cache tiled rasterdatasets
  -q, --quiet                Decrease verbosity.
  -v, --verbose              Increase verbosity.
  --help                     Show this message and exit.

Update Wflow gauging stations#

[5]:

# NOTE: copy this line (without !) to your shell for more direct feedback
! hydromt update wflow wflow_piave_subbasin -o ./wflow_piave_gauges -c setup_gauges --opt gauges_fn=test_stations.csv --opt basename=test-flow -v

2024-12-18 18:39:02,076 - update - log - INFO - HydroMT version: 0.10.0
2024-12-18 18:39:02,076 - update - main - INFO - Updating wflow model at /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_subbasin (r).
2024-12-18 18:39:02,076 - update - main - INFO - Output dir: /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_gauges
2024-12-18 18:39:02,076 - update - main - INFO - User settings:
2024-12-18 18:39:02,435 - update - model_api - INFO - Initializing wflow model from hydromt_wflow (v0.7.1.dev0).
2024-12-18 18:39:02,435 - update - data_catalog - INFO - Parsing data catalog from /home/runner/work/hydromt_wflow/hydromt_wflow/hydromt_wflow/data/parameters_data.yml
2024-12-18 18:39:02,450 - update - wflow - INFO - Read grid from /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_subbasin/staticmaps.nc
2024-12-18 18:39:02,503 - update - wflow - INFO - Reading model staticgeom files.
2024-12-18 18:39:02,543 - update - wflow - INFO - Read forcing from /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_subbasin/inmaps.nc
2024-12-18 18:39:02,559 - update - wflow - INFO - Reading model intbl files.
2024-12-18 18:39:02,559 - update - wflow - INFO - Reading model table files.
2024-12-18 18:39:02,559 - update - wflow - INFO - Model read
2024-12-18 18:39:02,562 - update - model_api - INFO - setup_gauges.gauges_fn: test_stations.csv
2024-12-18 18:39:02,562 - update - model_api - INFO - setup_gauges.index_col: None
2024-12-18 18:39:02,562 - update - model_api - INFO - setup_gauges.snap_to_river: True
2024-12-18 18:39:02,562 - update - model_api - INFO - setup_gauges.mask: None
2024-12-18 18:39:02,562 - update - model_api - INFO - setup_gauges.snap_uparea: False
2024-12-18 18:39:02,562 - update - model_api - INFO - setup_gauges.max_dist: 10000.0
2024-12-18 18:39:02,562 - update - model_api - INFO - setup_gauges.wdw: 3
2024-12-18 18:39:02,563 - update - model_api - INFO - setup_gauges.rel_error: 0.05
2024-12-18 18:39:02,563 - update - model_api - INFO - setup_gauges.abs_error: 50.0
2024-12-18 18:39:02,563 - update - model_api - INFO - setup_gauges.fillna: False
2024-12-18 18:39:02,563 - update - model_api - INFO - setup_gauges.derive_subcatch: False
2024-12-18 18:39:02,563 - update - model_api - INFO - setup_gauges.basename: test-flow
2024-12-18 18:39:02,563 - update - model_api - INFO - setup_gauges.toml_output: csv
2024-12-18 18:39:02,563 - update - model_api - INFO - setup_gauges.gauge_toml_header: ['Q', 'P']
2024-12-18 18:39:02,563 - update - model_api - INFO - setup_gauges.gauge_toml_param: ['lateral.river.q_av', 'vertical.precipitation']
2024-12-18 18:39:02,565 - update - geodataframe - INFO - Reading  csv data from test_stations.csv
2024-12-18 18:39:02,570 - update - wflow - INFO - 3 test-flow gauge locations found within domain
2024-12-18 18:39:04,283 - update - wflow - INFO - Adding ['lateral.river.q_av', 'vertical.precipitation'] to csv section of toml.
2024-12-18 18:39:04,283 - update - wflow - INFO - Write model data to /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_gauges
2024-12-18 18:39:04,324 - update - wflow - INFO - Write grid to /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_gauges/staticmaps.nc
2024-12-18 18:39:04,637 - update - wflow - INFO - Writing model staticgeom to file.
2024-12-18 18:39:04,720 - update - wflow - INFO - Write forcing file
2024-12-18 18:39:04,730 - update - wflow - INFO - Process forcing; saving to /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_gauges/inmaps.nc
[########################################] | 100% Completed | 100.90 ms
2024-12-18 18:39:04,839 - update - wflow - INFO - Writing model config to /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_gauges/wflow_sbm.toml

The example above means the following: run hydromt with:

  • update wflow: i.e. update a wflow model

  • wflow_piave_subbasin: original model folder

  • -o ./wflow_piave_gauges: output updated model folder

  • -c setup_gauges: model component to update, here setup_gauges to add gauging stations

  • --opt gauges_fn=test_stations.csv: name in hydromt data catalog or path to a csv file containing the gauges locations

  • --opt basename=test-flow: name of the new gauges map in the staticmaps of Wflow

  • v: give some extra verbosity (2 * v) to display feedback on screen. Now debug messages are provided.

Other available options are available in the docs (setup gauges).

Update Wflow gauging stations without snapping#

By default, the setup_gauges of HydroMT Wflow will assume that gauges are for flow sampling and will therefore snap the gauges locations to the river. If your observations are used to compare rainfall data, then you do not want HydroMT to move the location of your gauges. This is done by setting --opt snap_to_river=False.

By default, HydroMT Wflow will update the TOML in order to save both river discharge and precipitation at the new gauges locations. With our rainfall stations, we only need to save the precipitation. We can set this with hydroMT using the options:

  • --opt gauge_toml_header="['P-station']": set the column name in the outputcsv file of the Wflow run in the TOML configuration

  • --opt gauge_toml_param="['vertical.precipitation']": set the Wflow variable to save in the corresponding outputcsv file column of Wflow run in the TOML configuration

[6]:

# NOTE: copy this line (without !) to your shell for more direct feedback
! hydromt update wflow wflow_piave_gauges -c setup_gauges --opt gauges_fn=test_stations.csv --opt basename=test-rain --opt snap_to_river=False --opt gauge_toml_header="['P-station']" --opt gauge_toml_param="['vertical.precipitation']" -v

2024-12-18 18:39:06,994 - update - log - INFO - HydroMT version: 0.10.0
2024-12-18 18:39:06,994 - update - main - INFO - Updating wflow model at /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_gauges (r+).
2024-12-18 18:39:06,994 - update - main - INFO - Output dir: /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_gauges
2024-12-18 18:39:06,994 - update - main - INFO - User settings:
2024-12-18 18:39:07,344 - update - model_api - INFO - Initializing wflow model from hydromt_wflow (v0.7.1.dev0).
2024-12-18 18:39:07,344 - update - data_catalog - INFO - Parsing data catalog from /home/runner/work/hydromt_wflow/hydromt_wflow/hydromt_wflow/data/parameters_data.yml
2024-12-18 18:39:07,359 - update - wflow - INFO - Reading model staticgeom files.
2024-12-18 18:39:07,375 - update - wflow - INFO - Read grid from /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_gauges/staticmaps.nc
2024-12-18 18:39:07,454 - update - model_api - INFO - setup_gauges.gauges_fn: test_stations.csv
2024-12-18 18:39:07,454 - update - model_api - INFO - setup_gauges.index_col: None
2024-12-18 18:39:07,454 - update - model_api - INFO - setup_gauges.snap_to_river: False
2024-12-18 18:39:07,454 - update - model_api - INFO - setup_gauges.mask: None
2024-12-18 18:39:07,454 - update - model_api - INFO - setup_gauges.snap_uparea: False
2024-12-18 18:39:07,454 - update - model_api - INFO - setup_gauges.max_dist: 10000.0
2024-12-18 18:39:07,454 - update - model_api - INFO - setup_gauges.wdw: 3
2024-12-18 18:39:07,454 - update - model_api - INFO - setup_gauges.rel_error: 0.05
2024-12-18 18:39:07,454 - update - model_api - INFO - setup_gauges.abs_error: 50.0
2024-12-18 18:39:07,455 - update - model_api - INFO - setup_gauges.fillna: False
2024-12-18 18:39:07,455 - update - model_api - INFO - setup_gauges.derive_subcatch: False
2024-12-18 18:39:07,455 - update - model_api - INFO - setup_gauges.basename: test-rain
2024-12-18 18:39:07,455 - update - model_api - INFO - setup_gauges.toml_output: csv
2024-12-18 18:39:07,455 - update - model_api - INFO - setup_gauges.gauge_toml_header: ['P-station']
2024-12-18 18:39:07,455 - update - model_api - INFO - setup_gauges.gauge_toml_param: ['vertical.precipitation']
2024-12-18 18:39:07,456 - update - geodataframe - INFO - Reading  csv data from test_stations.csv
2024-12-18 18:39:07,460 - update - wflow - INFO - 3 test-rain gauge locations found within domain
2024-12-18 18:39:08,205 - update - wflow - INFO - Adding ['vertical.precipitation'] to csv section of toml.
2024-12-18 18:39:08,206 - update - wflow - INFO - Write model data to /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_gauges
2024-12-18 18:39:08,206 - update - data_catalog - INFO - Parsing data catalog from /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_gauges/hydromt_data.yml
2024-12-18 18:39:08,249 - update - wflow - INFO - Write grid to /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_gauges/staticmaps.nc
2024-12-18 18:39:08,666 - update - wflow - INFO - Writing model staticgeom to file.
2024-12-18 18:39:08,751 - update - wflow - INFO - Writing model config to /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_gauges/wflow_sbm.toml

The example above means the following: run hydromt with:

  • update wflow: i.e. update a wflow model

  • wflow_piave_gauges: model folder to update (here we save our updates in the same model folder)

  • -c setup_gauges: model component to update, here setup_gauges to add gauging stations

  • --opt gauges_fn=test_stations.csv: name in hydromt data catalog or path to a csv file containing the gauges locations

  • --opt basename=test-rain: name of the new gauges map in the staticmaps of Wflow

  • --opt snap_to_river=False

  • --opt gauge_toml_header="['P-station']": set the column name in the outputcsv file of the Wflow run in the TOML configuration

  • --opt gauge_toml_param="['vertical.precipitation']": set the Wflow variable to save in the corresponding outputcsv file column of Wflow run in the TOML configuration

  • v: give some extra verbosity (2 * v) to display feedback on screen. Now debug messages are provided.

Other available options are available in the docs (setup gauges).

Note: when changing several options, the command line can get quite long. You can also create a HydroMT configuration file where you set all the different options and use it in your command line with the -i argument instead of -c and several --opt

Visualization of the gauges#

We can now plot our newly created gauges stations maps and check the differences between the flow and rain maps.

[7]:

# Load the updated model with hydromt
from hydromt_wflow import WflowModel

mod = WflowModel(root="wflow_piave_gauges", mode="r")

[8]:

# read/derive river geometries
gdf_riv = mod.rivers
# read/derive model basin boundary
gdf_bas = mod.basins

[9]:

# Plot
# we assume the model maps are in the geographic CRS EPSG:4326
proj = ccrs.PlateCarree()
# adjust zoomlevel and figure size to your basis size & aspect
zoom_level = 10
figsize = (10, 8)
shaded = False

# initialize image with geoaxes
fig = plt.figure(figsize=figsize)
ax = fig.add_subplot(projection=proj)
bbox = mod.grid.raster.box.to_crs(3857).buffer(5e3)
extent = np.array(bbox.to_crs(mod.grid.raster.crs).total_bounds)[[0, 2, 1, 3]]
ax.set_extent(extent, crs=proj)

# add sat background image
ax.add_image(cimgt.QuadtreeTiles(), zoom_level, alpha=0.5)

# plot rivers with increasing width with stream order
gdf_riv.plot(ax=ax, lw=gdf_riv["strord"] / 2, color="blue", zorder=3, label="river")
# plot the basin boundary
gdf_bas.boundary.plot(ax=ax, color="k", linewidth=0.5)

if "gauges" in mod.geoms:
    mod.geoms["gauges"].plot(
        ax=ax, marker="d", markersize=25, facecolor="k", zorder=5, label="outlet"
    )
if "gauges_grdc" in mod.geoms:
    mod.geoms["gauges_grdc"].plot(
        ax=ax,
        marker="d",
        markersize=25,
        facecolor="purple",
        zorder=5,
        label="Gauges GRDC",
    )
if "gauges_test-flow" in mod.geoms:
    mod.geoms["gauges_test-flow"].plot(
        ax=ax, marker="d", markersize=25, facecolor="red", zorder=5, label="Gauges Flow"
    )
if "gauges_test-rain" in mod.geoms:
    mod.geoms["gauges_test-rain"].plot(
        ax=ax,
        marker="d",
        markersize=25,
        facecolor="green",
        zorder=5,
        label="Gauges Rain",
    )

ax.xaxis.set_visible(True)
ax.yaxis.set_visible(True)
ax.set_ylabel(f"latitude [degree north]")
ax.set_xlabel(f"longitude [degree east]")
_ = ax.set_title(f"wflow base map")
legend = ax.legend(
    handles=[*ax.get_legend_handles_labels()[0]],
    title="Legend",
    loc="lower right",
    frameon=True,
    framealpha=0.7,
    edgecolor="k",
    facecolor="white",
)
../_images/_examples_update_model_gauges_24_0.png