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 setup methods#

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

Configuration (TOML)#

Method	Explanation	Required Setup Method
`setup_config()`	Update config with a dictionary
`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_basemaps()`
`setup_constant_pars()`	Setup constant parameter maps.

Topography and Rivers#

Method	Explanation	Required Setup Method
`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_basemaps()`
`setup_riverbedsed()`	Setup sediments based river bed characteristics maps.	`setup_rivers()`

Reservoirs#

Method	Explanation	Required Setup Method
`setup_natural_reservoirs()`	This component generates maps of lake (natural reservoirs) areas and outlets as well as parameters such as average area.	`setup_rivers()`
`setup_reservoirs()`	This component generates maps of reservoir areas and outlets as well as parameters such as average area.	`setup_rivers()`

Land Use and Vegetation#

Method	Explanation	Required Setup Method
`setup_lulcmaps()`	This component derives several wflow maps based on landuse- landcover (LULC) raster data.	`setup_basemaps()`
`setup_lulcmaps_from_vector()`	This component derives several wflow maps based on landuse- landcover (LULC) vector data.	`setup_basemaps()`
`setup_canopymaps()`	Setup sediments based canopy height maps.	`setup_basemaps()`

Soil#

Method	Explanation	Required Setup Method
`setup_soilmaps()`	Setup sediments based soil parameter maps.	`setup_basemaps()`

Output Locations#

Method	Explanation	Required Setup Method
`setup_outlets()`	This method sets the default gauge map based on basin outlets.	`setup_rivers()`
`setup_gauges()`	This method sets 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 methods#

Method	Explanation	Required Setup Method
`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 WflowSedimentModel components 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 model data#
`WflowSedimentModel` model	Wflow sediment files
`config`	wflow_sediment.toml
`staticmaps`	staticmaps.nc
`geoms`	geometries from the staticgeoms folder (basins.geojson, rivers.geojson etc.)
`forcing`	inmaps.nc
`states`	instates.nc
`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)