Wflow Sediment model

Initialize

WflowSedimentModel([root, mode, config_fn, …])

This is the wflow sediment model class, a subclass of WflowModel

Build components

WflowSedimentModel.setup_config(**cfdict)

Update config with a dictionary

WflowSedimentModel.setup_basemaps(region[, …])

This component sets the region of interest and res (resolution in degrees) of the model.

WflowSedimentModel.setup_rivers([…])

This component sets the river parameter maps including a boolean river mask, length, slope.

WflowSedimentModel.setup_lakes([lakes_fn, …])

This component generates maps of lake areas and outlets as well as parameters with average lake area, depth a discharge values.

WflowSedimentModel.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.

WflowSedimentModel.setup_lulcmaps([lulc_fn, …])

This component derives several wflow maps are derived based on landuse- landcover (LULC) data.

WflowSedimentModel.setup_laimaps([lai_fn])

This component sets leaf area index (LAI) climatoloy maps per month.

WflowSedimentModel.setup_canopymaps([canopy_fn])

Setup sediments based canopy height maps.

WflowSedimentModel.setup_soilmaps([soil_fn, …])

Setup sediments based soil parameter maps.

WflowSedimentModel.setup_riverwidth([…])

This component sets the river width parameter based on a power-lay relationship with a predictor.

WflowSedimentModel.setup_riverbedsed([…])

Setup sediments based river bed characteristics maps.

WflowSedimentModel.setup_gauges([gauges_fn, …])

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

WflowSedimentModel.setup_constant_pars(**kwargs)

Setup constant parameter maps.

Model specific attributes

WflowSedimentModel.flwdir

Returns the pyflwdir.FlwdirRaster object parsed from the wflow ldd.

WflowSedimentModel.basins

Returns a basin(s) geometry as a geopandas.GeoDataFrame.

WflowSedimentModel.rivers

Returns a river geometry as a geopandas.GeoDataFrame.

Model specific methods

WflowSedimentModel.set_flwdir([ftype])

Parse pyflwdir.FlwdirRaster object parsed from the wflow ldd

WflowSedimentModel.clip_staticmaps(region[, …])

Clip staticmaps to subbasin.

WflowSedimentModel.clip_forcing([crs])

Return clippped forcing for subbasin.