Model methods and components#

The HydroMT-Wflow plugin helps you preparing or updating several inputs of a Wflow model such as topography information, landuse, soil or forcing using setup methods. The main interactions are available from the HydroMT Command Line Interface and allow you to configure HydroMT in order to build or update or clip Wflow models.

When building or updating a model from command line a model region; a model setup configuration (.yml file) with model methods and options and, optionally, a data catalog (.yml) file should be prepared.

Model setup methods#

An overview of the available Wflow model setup methods is provided in the tables below. When using HydroMT from the command line only the setup methods are exposed. Click on a specific method to see its documentation.

Configuration (TOML)#

Defines and manages model configuration, global parameters, and output settings.

Method	Explanation	Required Setup Method
`setup_config()`	Update config with a dictionary
`setup_config_output_timeseries()`	Add new variable/column to the netcdf/csv output section of the toml based on a selected gauge/area map.	`setup_basemaps()`
`setup_constant_pars()`	Setup constant parameter maps for all active model cells.

Topography and Rivers#

Prepares elevation maps, drainage networks, and river-related features used to simulate flow routing and floodplain processes.

Method	Explanation	Required Setup Method
`setup_basemaps()`	Set the region of interest and res (resolution in degrees) of the model.
`setup_rivers()`	Set all river parameter maps.	`setup_basemaps()`
`setup_river_roughness()`	Set river Manning roughness coefficient.	`setup_rivers()`
`setup_floodplains()`	Add floodplain information (can be either 1D or 2D).	`setup_rivers()`

Reservoirs and Glaciers#

Adds reservoirs and glaciers, and defines their impact on hydrological storage and flow regulation.

Method	Explanation	Required Setup Method
`setup_reservoirs_no_control()`	Generate maps of uncontrolled reservoirs (lakes, weirs) areas and outlets as well as parameters with average reservoir area, depth a discharge values.	`setup_rivers()`
`setup_reservoirs_simple_control()`	Generate maps of controlled reservoir areas and outlets as well as parameters with average reservoir area, demand, min and max target storage capacities and discharge capacity values.	`setup_rivers()`
`setup_glaciers()`	Generate maps of glacier areas, area fraction and volume fraction, as well as tables with temperature threshold, melting factor and snow-to-ice conversion fraction.	`setup_basemaps()`

Land Use and Vegetation#

Defines land use and vegetation properties, including LULC and LAI maps, which influence evapotranspiration and interception processes.

Method	Explanation	Required Setup Method
`setup_lulcmaps()`	Derive several wflow maps based on landuse- landcover (LULC) raster data.	`setup_basemaps()`
`setup_lulcmaps_from_vector()`	Derive several wflow maps based on landuse- landcover (LULC) vector data.	`setup_basemaps()`
`setup_lulcmaps_with_paddy()`	Derive several wflow maps based on landuse- landcover (LULC) raster data with paddy rice.	`setup_soilmaps()`
`setup_laimaps()`	Set leaf area index (LAI) climatology maps per month.	`setup_basemaps()`
`setup_laimaps_from_lulc_mapping()`	Set leaf area index (LAI) climatology maps per month based on landuse mapping.	`setup_basemaps()`
`setup_rootzoneclim()`	Derive an estimate of the rooting depth from hydroclimatic data (as an alternative from the look-up table). The method can be applied for current conditions and future climate change conditions.	`setup_soilmaps()`, `setup_laimaps()` or equivalent

Soil#

Sets up soil-related data including soil maps and hydraulic properties.

Method	Explanation	Required Setup Method
`setup_soilmaps()`	Derive several (layered) soil parameters based on a database with physical soil properties using available point-scale (pedo)transfer functions (PTFs) from literature with upscaling rules to ensure flux matching across scales.	`setup_basemaps()`
`setup_ksathorfrac()`	Prepare the saturated hydraulic conductivity horizontal ratio from an existing map.	`setup_basemaps()`
`setup_ksatver_vegetation()`	Prepare ksatver from soil and vegetation parameters.	`setup_soilmaps()`, `setup_laimaps()` or equivalent.

Water demands and Allocation#

Defines domestic, irrigation, and other water demand maps and allocation parameters.

Method	Explanation	Required Setup Method
`setup_allocation_areas()`	Create water demand allocation areas.	`setup_rivers()`
`setup_allocation_surfacewaterfrac()`	Create fraction of surface water used for allocation of the water demands.	`setup_basemaps()`
`setup_domestic_demand()`	Create domestic water demand from grid.	`setup_basemaps()`
`setup_domestic_demand_from_population()`	Create domestic water demand using demand per capita and gridded population.	`setup_basemaps()`
`setup_other_demand()`	Create other water demand (eg industry, livestock).	`setup_basemaps()`
`setup_irrigation()`	Create irrigation areas and trigger for paddy and nonpaddy crops from a raster file.	`setup_lulcmaps()` or equivalent, `setup_laimaps()` or equivalent
`setup_irrigation_from_vector()`	Create irrigation areas and trigger for paddy and nonpaddy crops from a vector file.	`setup_lulcmaps()` or equivalent, `setup_laimaps()` or equivalent

Forcing#

Sets up meteorological forcing inputs such as precipitation, temperature, and potential evapotranspiration.

Method	Explanation	Required Setup Method
`setup_precip_forcing()`	Setup gridded precipitation forcing at model resolution.	`setup_basemaps()`
`setup_precip_from_point_timeseries()`	Setup precipitation forcing from station data at model resolution.	`setup_basemaps()`
`setup_temp_pet_forcing()`	Setup gridded temperature and optionally compute reference evapotranspiration forcing at model resolution.	`setup_basemaps()`
`setup_pet_forcing()`	Setup gridded reference evapotranspiration forcing at model resolution.	`setup_basemaps()`

States#

Defines initial hydrological state variables such as soil moisture and groundwater storage.

Method	Explanation	Required Setup Method
`setup_cold_states()`	Setup wflow cold states based on data in staticmaps.	`setup_soilmaps()`, `setup_constant_pars()`, `setup_reservoirs_no_control()`, `setup_reservoirs_simple_control()`, `setup_glaciers()`, `setup_irrigation()` or equivalent

Output Locations#

Defines outlets, gauges, and spatial masks used for reporting model results.

Method	Explanation	Required Setup Method
`setup_outlets()`	Set the default gauge map based on basin outlets.	`setup_rivers()`
`setup_gauges()`	Set the default gauge map based on a gauges_fn data.	`setup_rivers()`
`setup_areamap()`	Setup area map from vector data to save wflow outputs for specific area.	`setup_basemaps()`

Other Setup Methods#

Additional high-level utilities to modify model geometry, link external models, or upgrade model versions.

Method	Explanation	Required Setup Method
`setup_1dmodel_connection()`	Setup subbasins and gauges to save results from wflow to be used in 1D river models.	`setup_rivers()`
`setup_grid_from_raster()`	Setup staticmaps from raster to add parameters from direct data.	`setup_basemaps()`
`upgrade_to_v1_wflow()`	Upgrade a model from a Wflow.jl 0.x to 1.0 .
`clip()`	Clip a sub-region of an existing model.

Model components#

The following table provides an overview of which WflowSbmModel components contains which Wflow in- and output files. The files are read and written with the associated read- and write- methods, i.e. read() and write() for the config component.

Wflow model data#
`WflowSbmModel` model	Wflow files
`config`	wflow_sbm.toml
`staticmaps`	staticmaps.nc
`geoms`	geometries from the staticgeoms folder (basins.geojson, rivers.geojson etc.)
`forcing`	inmaps.nc
`states`	instates.nc
`tables`	tabular data (csv format, e.g. lake_hq.csv, lake_sh.csv)
`output_grid`	output.nc (defined in [output.netcdf_grid] TOML section)
`output_scalar`	output_scalar.nc (defined in [output.netcdf_scalar] TOML section)
`output_csv`	output.csv (defined in [output.csv] TOML section)