Model methods and components#

The HydroMT-Wflow plugin helps you preparing or updating several methods of a Wflow model such as topography information, landuse, soil or forcing. 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 sources (.yml) file should be prepared.

Model setup methods#

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

Method	Explanation
`setup_config()`	Update config with a dictionary
`setup_basemaps()`	This component sets the region of interest and res (resolution in degrees) of the model.
`setup_rivers()`	This component sets the all river parameter maps.
`setup_floodplains()`	This component This components adds floodplain information to the model schematization (can be either 1D or 2D).
`setup_lakes()`	This component generates maps of lake areas and outlets as well as parameters with average lake area, depth a discharge values.
`setup_reservoirs()`	This component generates maps of reservoir areas and outlets as well as parameters with average reservoir area, demand, min and max target storage capacities and discharge capacity values.
`setup_glaciers()`	This component generates 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_lulcmaps()`	This component derives several wflow maps based on landuse- landcover (LULC) data.
`setup_lulcmaps_with_paddy()`	This component derives several wflow maps based on landuse- landcover (LULC) data with paddy rice.
`setup_laimaps()`	This component sets leaf area index (LAI) climatology maps per month.
`setup_laimaps_from_lulc_mapping()`	This component sets leaf area index (LAI) climatology maps per month based on landuse mapping.
`setup_soilmaps()`	This component derives 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_ksathorfrac()`	This component prepares ksathorfrac from existing ksathorfrac data.
`setup_rootzoneclim()`	This component derives 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_outlets()`	This method sets the default gauge map based on basin outlets.
`setup_gauges()`	This method sets the default gauge map based on a gauges_fn data.
`setup_areamap()`	Setup area map from vector data to save wflow outputs for specific area.
`setup_config_output_timeseries()`	This method add new variable/column to the netcf/csv output section of the toml based on a selected gauge/area map.
`setup_precip_forcing()`	Setup gridded precipitation forcing at model resolution.
`setup_temp_pet_forcing()`	Setup gridded temperature and optionally compute reference evapotranspiration forcing at model resolution.
`setup_pet_forcing()`	Setup gridded reference evapotranspiration forcing at model resolution.
`setup_constant_pars()`	Setup constant parameter maps for all active model cells.
`setup_allocation_areas()`	Create water demand allocation areas.
`setup_allocation_surfacewaterfrac()`	Create fraction of surface water used for allocation of the water demands.
`setup_domestic_demand()`	Create domestic water demand.
`setup_other_demand()`	Create other water demand (eg industry, livestock).
`setup_irrigation()`	Create irrigation areas and trigger for paddy and nonpaddy crops.
`setup_1dmodel_connection()`	Setup subbasins and gauges to save results from wflow to be used in 1D river models.
`setup_grid_from_raster()`	Setup staticmaps from raster to add parameters from direct data.
`setup_cold_states()`	Setup wflow cold states based on data in staticmaps.

Model components#

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

`WflowModel` component	Wflow files
`config`	wflow_sbm.toml
`grid`	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)
`results`	output.nc, output_scalar.nc, output.csv
`staticmaps` (deprecated, removed in hydromt_wflow v0.6.0)	staticmaps.nc
`staticgeoms` (deprecated, removed in hydromt_wflow v0.6.0)	geometries from the staticgeoms folder (basins.geojson, rivers.geojson etc.)