Tip
Update a Wflow model: landuse#
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 the landuse map and parameters.
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 direct feedback.
Import packages#
In this notebook, we will use some functions of HydroMT to check available datasets and also to plot the landuse maps from the original and updated models. Here are the libraries to import to realize these steps.
[1]:
import numpy as np
import pandas as pd
import hydromt
from hydromt_wflow import WflowModel
# for plotting
import matplotlib as mpl
import matplotlib.pyplot as plt
import cartopy.crs as ccrs
proj = ccrs.PlateCarree() # plot projection
Searching the data catalog for landuse#
In our previous notebook, we built a Wflow model using the GlobCover landuse classification. But we could as well have chosen another one. Let’s what other landuse landcover data are available in HydroMT and choose another landuse classification for our model. For this we will open the data catalog.
You can also directly open and search the HydroMT yaml library by downloading and opening the data_catalog.yml file in hydromt-artifacts or look at the list of data sources in the documentation.
[2]:
# Load the default data catalog of HydroMT
data_catalog = hydromt.DataCatalog("artifact_data")
[3]:
# Check which landuse/lancover sources are available in the DataCatalog
data_table = data_catalog.to_dataframe()
data_table.source_url[data_table["category"] == "landuse & landcover"]
[3]:
name
corine https://land.copernicus.eu/pan-european/corine...
globcover_2009 http://due.esrin.esa.int/page_globcover.php
modis_lai https://lpdaac.usgs.gov/products/mcd15a3hv006/
simard https://webmap.ornl.gov/ogc/dataset.jsp?ds_id=...
vito_2015 https://land.copernicus.eu/global/products/lc
Name: source_url, dtype: object
Here we can see that we have five data sources in HydroMT related to landuse & landcover properties. Out of these, three are landuse classifications:
globcover_2009 (already used in our current model)
corine
vito_2015
The other datasets include a Leaf Area Index dataset (modis_lai) and a canopy height dataset (simard).
Let’s now see how to update our current model in one command line to use the corine classification.
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.
Model setup configuration#
To let HydroMT know which setup method to call and the options, you can prepare and use a configuration file that includes every methods and settings that you want to do during your update.
The HydroMT configuration file (YAML) contains the model setup configuration and determines which methods are updated and in which sequence and sets optional arguments for each method. This configuration is passed to hydromt using -i <path_to_config_file>.
Each header (without indent) (e.g. setup_lulcmaps:) corresponds with a model method which are explained in the docs (model methods).
Let’s open the example configuration file wflow_update_landuse.yml from the model repository [examples folder] and have a look at the settings.
[5]:
fn_config = "wflow_update_landuse.yml"
with open(fn_config, "r") as f:
txt = f.read()
print(txt)
setup_lulcmaps:
lulc_fn : corine # source for lulc maps: {globcover, vito, corine}
lulc_mapping_fn: corine_mapping_default # default mapping for lulc classes
output_names_suffix: corine # add a suffix to the output map names in staticmaps rather than overwritting existing landuse maps
Here we can see that to fully update wflow forcing, we will run one methods of Wflow:
setup_lulcmaps: prepares landuse map and parameters based on a landuse map
lulc_fnand a mapping tablelulc_mapping_fnto convert from specific landuse classes (urban, forest) to hydrological parameters (roughness, depth of the vegetation roots etc).
Here, we can see that we will update the landuse with the classification from CORINE and using the HydroMT default mapping table for the parameter creation (HydroMT supports a few of these including “globcover”, “corine”, “vito” and “esa_worldcover”). If you want to use a different classification or update the default values (eg for calibration), you can create and catalog your own table.
We will also here save the different maps with the suffix “corine” via the output_names_suffix options. If this option is not provided (or None), the new maps will overwrite previously existing ones. Here we will keep both the globcover maps and the new maps from CORINE in the updated model.
You can find more information about the different options in the docs (setup lulcmaps)
Update Wflow landuse layers#
[6]:
# NOTE: copy this line (without !) to your shell for more direct feedback
! hydromt update wflow wflow_piave_subbasin -o ./wflow_piave_corine -i wflow_update_landuse.yml -d artifact_data -v
2025-06-26 14:10:25,631 - update - log - INFO - HydroMT version: 0.10.1
2025-06-26 14:10:25,632 - update - main - INFO - Updating wflow model at /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_subbasin (r).
2025-06-26 14:10:25,632 - update - main - INFO - Output dir: /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_corine
2025-06-26 14:10:25,632 - update - main - INFO - User settings:
2025-06-26 14:10:25,707 - update - data_catalog - INFO - Reading data catalog artifact_data latest
2025-06-26 14:10:25,707 - update - data_catalog - INFO - Parsing data catalog from /home/runner/.hydromt_data/artifact_data/v0.0.9/data_catalog.yml
2025-06-26 14:10:26,266 - update - model_api - INFO - Initializing wflow model from hydromt_wflow (v1.0.0rc1).
2025-06-26 14:10:26,266 - update - data_catalog - INFO - Parsing data catalog from /home/runner/work/hydromt_wflow/hydromt_wflow/hydromt_wflow/data/parameters_data.yml
2025-06-26 14:10:26,278 - update - wflow - INFO - Supported Wflow.jl version v1+
2025-06-26 14:10:26,315 - update - wflow - INFO - Read grid from /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_subbasin/staticmaps.nc
2025-06-26 14:10:27,005 - update - wflow - INFO - Reading model staticgeom files.
2025-06-26 14:10:27,051 - update - wflow - INFO - Read forcing from /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_subbasin/inmaps.nc
2025-06-26 14:10:27,070 - update - wflow - INFO - Reading model table files.
2025-06-26 14:10:27,070 - update - wflow - INFO - Model read
2025-06-26 14:10:27,074 - update - model_api - INFO - setup_lulcmaps.lulc_fn: corine
2025-06-26 14:10:27,074 - update - model_api - INFO - setup_lulcmaps.lulc_mapping_fn: corine_mapping_default
2025-06-26 14:10:27,075 - update - model_api - INFO - setup_lulcmaps.lulc_vars: {'landuse': None, 'vegetation_kext': 'vegetation_canopy__light-extinction_coefficient', 'land_manning_n': 'land_surface_water_flow__manning_n_parameter', 'soil_compacted_fraction': 'soil~compacted__area_fraction', 'vegetation_root_depth': 'vegetation_root__depth', 'vegetation_leaf_storage': 'vegetation__specific-leaf_storage', 'vegetation_wood_storage': 'vegetation_wood_water__storage_capacity', 'land_water_fraction': 'land~water-covered__area_fraction', 'vegetation_crop_factor': 'vegetation__crop_factor', 'vegetation_feddes_alpha_h1': 'vegetation_root__feddes_critial_pressure_head_h~1_reduction_coefficient', 'vegetation_feddes_h1': 'vegetation_root__feddes_critial_pressure_head_h~1', 'vegetation_feddes_h2': 'vegetation_root__feddes_critial_pressure_head_h~2', 'vegetation_feddes_h3_high': 'vegetation_root__feddes_critial_pressure_head_h~3~high', 'vegetation_feddes_h3_low': 'vegetation_root__feddes_critial_pressure_head_h~3~low', 'vegetation_feddes_h4': 'vegetation_root__feddes_critial_pressure_head_h~4'}
2025-06-26 14:10:27,075 - update - model_api - INFO - setup_lulcmaps.output_names_suffix: corine
2025-06-26 14:10:27,075 - update - wflow - INFO - Preparing LULC parameter maps.
2025-06-26 14:10:27,078 - update - rasterdataset - INFO - Reading corine raster data from /home/runner/.hydromt_data/artifact_data/v0.0.9/data.tar/corine.tif
2025-06-26 14:10:27,200 - update - dataframe - INFO - Reading corine_mapping_default csv data from /home/runner/work/hydromt_wflow/hydromt_wflow/hydromt_wflow/data/lulc/corine_mapping.csv
2025-06-26 14:10:27,219 - update - landuse - INFO - Deriving landuse using nearest resampling (nodata=999).
2025-06-26 14:10:27,386 - update - landuse - INFO - Deriving vegetation_kext using average resampling (nodata=-999.0).
2025-06-26 14:10:27,491 - update - landuse - INFO - Deriving land_manning_n using average resampling (nodata=-999.0).
2025-06-26 14:10:27,592 - update - landuse - INFO - Deriving soil_compacted_fraction using average resampling (nodata=-999.0).
2025-06-26 14:10:27,692 - update - landuse - INFO - Deriving vegetation_root_depth using average resampling (nodata=-999.0).
2025-06-26 14:10:27,794 - update - landuse - INFO - Deriving vegetation_leaf_storage using average resampling (nodata=-999.0).
2025-06-26 14:10:27,896 - update - landuse - INFO - Deriving vegetation_wood_storage using average resampling (nodata=-999.0).
2025-06-26 14:10:27,998 - update - landuse - INFO - Deriving land_water_fraction using average resampling (nodata=-999.0).
2025-06-26 14:10:28,098 - update - landuse - INFO - Deriving vegetation_crop_factor using average resampling (nodata=-999.0).
2025-06-26 14:10:28,199 - update - landuse - INFO - Deriving vegetation_feddes_alpha_h1 using mode resampling (nodata=-999).
2025-06-26 14:10:28,325 - update - landuse - INFO - Deriving vegetation_feddes_h1 using average resampling (nodata=-999).
2025-06-26 14:10:28,441 - update - landuse - INFO - Deriving vegetation_feddes_h2 using average resampling (nodata=-999).
2025-06-26 14:10:28,565 - update - landuse - INFO - Deriving vegetation_feddes_h3_high using average resampling (nodata=-999).
2025-06-26 14:10:28,687 - update - landuse - INFO - Deriving vegetation_feddes_h3_low using average resampling (nodata=-999).
2025-06-26 14:10:28,805 - update - landuse - INFO - Deriving vegetation_feddes_h4 using average resampling (nodata=-999).
2025-06-26 14:10:28,957 - update - wflow - INFO - Write model data to /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_corine
2025-06-26 14:10:29,005 - update - wflow - INFO - Write grid to /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_corine/staticmaps.nc
2025-06-26 14:10:29,059 - update - wflow - INFO - Writing model staticgeom to file.
2025-06-26 14:10:29,155 - update - wflow - INFO - Write forcing file
2025-06-26 14:10:29,166 - update - wflow - INFO - Process forcing; saving to /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_corine/inmaps.nc
[########################################] | 100% Completed | 100.65 ms
2025-06-26 14:10:29,278 - update - wflow - INFO - Writing model config to /home/runner/work/hydromt_wflow/hydromt_wflow/docs/_examples/wflow_piave_corine/wflow_sbm.toml
The example above means the following: run hydromt with:
update wflow: i.e. update a wflow modelwflow_piave_subbasin: original model folder-o ./wflow_piave_corine: output updated model folder-i wflow_update_landuse.yml: setup configuration file containing the components to update and their different options-d artifact_data: specify to use the artifact_data catalog-v: give some extra verbosity (2 * v) to display feedback on screen. Now debug messages are provided.
Model comparison#
From the information above, you can see that not only was the landuse map updated but also all wflow landuse-related parameters with it: Kext, N, PathFrac, RootingDepth, Sl, Swood and WaterFrac.
Let’s now have a look at the different landuse maps of our two models and check that they were indeed updated.
[7]:
# Load both models with hydromt
mod = WflowModel(root="wflow_piave_corine", mode="r")
[8]:
df = pd.read_csv("./legends/GLOBCOVER_2009_QGIS.txt", header=None, index_col=0)
# plot globcover map
levels = df.index
colors = (df.iloc[:-1, :4] / 255).values
ticklabs = df.iloc[:-1, 4].values
cmap, norm = mpl.colors.from_levels_and_colors(levels, colors)
ticks = np.array(levels[:-1]) + np.diff(levels) / 2.0
# create new figure
fig = plt.figure(figsize=(14, 7))
ax = fig.add_subplot(projection=proj)
# plot globcover landuse
mask = mod.grid["subcatchment"] > 0
p = (
mod.grid["meta_landuse"]
.raster.mask_nodata()
.plot(ax=ax, cmap=cmap, norm=norm, cbar_kwargs=dict(ticks=ticks))
)
p.axes.set_title("GlobCover LULC")
_ = p.colorbar.ax.set_yticklabels(ticklabs)
[9]:
# plot corine map
df = pd.read_csv(
"./legends/CLC2018_CLC2018_V2018_20_QGIS.txt", header=None, index_col=0
)
# plot corine map
levels = df.index
colors = (df.iloc[:-1, :4] / 255).values
ticklabs = df.iloc[:-1, 4].values
cmap, norm = mpl.colors.from_levels_and_colors(levels, colors)
ticks = np.array(levels[:-1]) + np.diff(levels) / 2.0
# create new figure
fig = plt.figure(figsize=(14, 7))
ax = fig.add_subplot(projection=proj)
# plot corine landuse
p = (
mod.grid["meta_landuse_corine"]
.raster.mask_nodata()
.plot(ax=ax, cmap=cmap, norm=norm, cbar_kwargs=dict(ticks=ticks))
)
p.axes.set_title("Corine LULC")
_ = p.colorbar.ax.set_yticklabels(ticklabs)
