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 (.ini 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_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 convertion fraction.

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_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 rulesto ensure flux matching across scales.

setup_hydrodem()

This component adds a hydrologically conditioned elevation (hydrodem) map for river and/or land local-inertial routing.

setup_gauges()

This method sets the default gauge map based on basin outlets and additional gauge maps based on gauges_fn data.

setup_areamap()

Setup area map from vector data to save wflow outputs for specific area.

setup_precip_forcing()

Setup gridded precipitation forcing at model resolution.

setup_temp_pet_forcing()

Setup gridded reference evapotranspiration forcing at model resolution.

setup_constant_pars()

Setup constant parameter maps for all active model cells.

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

staticmaps

staticmaps.nc

staticgeoms

geometries from the staticgeoms folder (basins.geojson, rivers.geojson etc.)

forcing

inmaps.nc

states

instates.nc

results

output.nc, output_scalar.nc, output.csv