Model methods and components#

This plugin helps you preparing or updating several components of a Wflow Sediment model such as topography information, landuse or soil. 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 Sediment models.

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

Model methods#

An overview of the available Wflow Sediment model setup components is provided in the table below. When using HydroMT from the command line only the setup components 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_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 lake areas and outlets as well as parameters with average reservoir area, demand, min and max target storage capacities and discharge capacity values.
`setup_lulcmaps()`	This component derives several wflow maps are derived based on landuse- landcover (LULC) data.
`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_canopymaps()`	Setup sediments based canopy height maps.
`setup_soilmaps()`	Setup sediments based soil parameter maps.
`setup_riverwidth()`	This component sets the river width parameter based on a power-lay relationship with a predictor.
`setup_riverbedsed()`	Setup sediments based river bed characteristics maps.
`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 a new variable/column to the netcf/csv output section of the toml based on a selected gauge/area map.
`setup_constant_pars()`	Setup constant parameter maps.
`setup_grid_from_raster()`	Setup staticmaps from raster to add parameters from direct data.

model components#

The following table provides an overview of which WflowSedimentModel component contains which Wflow Sediment 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.

Wflow Sediment mdel data#
`WflowSedimentModel` component	Wflow sediment files
`config`	wflow_sediment.toml
`grid`	staticmaps.nc
`geoms`	geometries from the staticgeoms folder (basins.geojson, rivers.geojson etc.)
`forcing`	inmaps.nc
`states`	instates.nc
`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.)