WflowSbmModel#

The WflowSbmModel class represents the main hydrological model implementation using the SBM concept.

Note

Note that this class inherits from WflowBaseModel and thereby includes all base functionalities, I/O routines, and setup methods from the base model. Also, note that some setup methods are overridden or extended to include SBM-specific parameters and data. To know more about this, see WflowBaseModel.

WflowSbmModel([root, config_filename, mode, ...])

Class to read, write, build, update wflow-SBM models.

Setup methods#

Configuration#

Defines and manages model configuration, global parameters, and output settings.

`WflowSbmModel.setup_config`(data)	Set the config dictionary at key(s) with values.
`WflowSbmModel.setup_config_output_timeseries`(mapname)	Set the default gauge map based on basin outlets.
`WflowSbmModel.setup_constant_pars`(**kwargs)	Generate constant parameter maps for all active model cells.

Topography and Rivers#

Prepares elevation maps, drainage networks, and river-related features used to simulate flow routing and floodplain processes.

`WflowSbmModel.setup_basemaps`(region, ...[, ...])	Build the DEM and flow direction for a Wflow model.
`WflowSbmModel.setup_rivers`(hydrography_fn[, ...])	Set full river parameter maps including river depth and bank elevation.
`WflowSbmModel.setup_riverwidth`([predictor, ...])	Set the river width parameter based on power-law relationship with a predictor.
`WflowSbmModel.setup_river_roughness`([...])	Set river Manning roughness coefficient for SBM.
`WflowSbmModel.setup_floodplains`(...[, ...])	Add floodplain information to the model schematisation.

Reservoirs and Glaciers#

Adds reservoirs and glaciers, and defines their impact on hydrological storage and flow regulation.

`WflowSbmModel.setup_reservoirs_no_control`(...)	Generate maps of reservoir areas, outlets and parameters.
`WflowSbmModel.setup_reservoirs_simple_control`(...)	Generate maps of controlled reservoir areas, outlets and parameters.
`WflowSbmModel.setup_glaciers`(glaciers_fn[, ...])	Generate maps of glacier areas, area fraction and volume fraction.

Land Use and Vegetation#

Defines land use and vegetation properties, including LULC and LAI maps, which influence evapotranspiration and interception processes.

`WflowSbmModel.setup_lulcmaps`(lulc_fn, *[, ...])	Derive several wflow maps based on landuse-landcover (LULC) data.
`WflowSbmModel.setup_lulcmaps_from_vector`(...)	Derive several wflow maps based on vector landuse-landcover (LULC) data.
`WflowSbmModel.setup_lulcmaps_with_paddy`(...)	Set up landuse maps and parameters including for paddy fields.
`WflowSbmModel.setup_laimaps`(lai_fn[, ...])	Set leaf area index (LAI) climatology maps per month [1,2,3,...,12].
`WflowSbmModel.setup_laimaps_from_lulc_mapping`(...)	Derive cyclic LAI maps from a LULC data source and a LULC-LAI mapping table.
`WflowSbmModel.setup_rootzoneclim`(run_fn, ...)	Set the vegetation_root_depth.

Soil#

Sets up soil-related data including soil maps and hydraulic properties.

`WflowSbmModel.setup_soilmaps`([soil_fn, ...])	Derive several (layered) soil parameters.
`WflowSbmModel.setup_ksathorfrac`(ksat_fn[, ...])	Set KsatHorFrac parameter values from a predetermined map.
`WflowSbmModel.setup_ksatver_vegetation`([...])	Correct vertical saturated hydraulic conductivity with vegetation properties.

Water Demands and Allocation#

Defines domestic, irrigation, and other water demand maps and allocation parameters.

`WflowSbmModel.setup_allocation_areas`(...[, ...])	Create water demand allocation areas.
`WflowSbmModel.setup_allocation_surfacewaterfrac`(...)	Create the fraction of water allocated from surface water.
`WflowSbmModel.setup_domestic_demand`(domestic_fn)	Prepare domestic water demand maps from a raster dataset.
`WflowSbmModel.setup_domestic_demand_from_population`(...)	Prepare domestic water demand maps from statistics per capita.
`WflowSbmModel.setup_other_demand`(demand_fn)	Create water demand maps from other sources (e.g. industry, livestock).
`WflowSbmModel.setup_irrigation`(...[, ...])	Add required information to simulate irrigation water demand from grid.
`WflowSbmModel.setup_irrigation_from_vector`(...)	Add required information to simulate irrigation water demand from vector.

Forcing#

Sets up meteorological forcing inputs such as precipitation, temperature, and potential evapotranspiration.

`WflowSbmModel.setup_precip_forcing`(precip_fn)	Generate gridded precipitation forcing at model resolution.
`WflowSbmModel.setup_precip_from_point_timeseries`(...)	Generate gridded precipitation from point timeseries (requires wradlib).
`WflowSbmModel.setup_temp_pet_forcing`(temp_pet_fn)	Generate gridded temperature and reference evapotranspiration forcing.
`WflowSbmModel.setup_pet_forcing`(pet_fn[, ...])	Prepare PET forcing from existig PET data.

States#

Defines initial hydrological state variables such as soil moisture and groundwater storage.

WflowSbmModel.setup_cold_states([timestamp])

Prepare cold states for Wflow.

Output Locations#

Defines outlets, gauges, and spatial masks used for reporting model results.

`WflowSbmModel.setup_outlets`([river_only, ...])	Set the default gauge map based on basin outlets.
`WflowSbmModel.setup_gauges`(gauges_fn[, ...])	Set a gauge map based on `gauges_fn` data.
`WflowSbmModel.setup_areamap`(area_fn, col2raster)	Set area map from vector data to save wflow outputs for specific area.

Other Setup Methods#

Additional high-level utilities to modify model geometry, link external models, or upgrade model versions.

`WflowSbmModel.setup_grid_from_raster`(...[, ...])	Add data variable(s) from `raster_fn` to grid object.
`WflowSbmModel.setup_1dmodel_connection`(...)	Connect wflow to a 1D model by deriving linked subcatch (and tributaries).
`WflowSbmModel.upgrade_to_v1_wflow`()	Upgrade the model to wflow v1 format.
`WflowSbmModel.clip`(region[, inverse_clip, ...])	Clip model to region.

Components#

If you are using python, you can access and update the model data using the components such as config, staticmaps etc. This is for example useful for computing statictics, plotting etc. The components data are usually xarray, dictionnary or geopandas objects and can be accessed via the data property: model.staticmaps.data. The components of the WflowSbmModel are:

Model Component	Component class
`model.config`	`WflowConfigComponent`
`model.staticmaps`	`WflowStaticmapsComponent`
`model.geoms`	`WflowGeomsComponent`
`model.forcing`	`WflowForcingComponent`
`model.states`	`WflowStatesComponent`
`model.tables`	`WflowTablesComponent`
`model.output_grid`	`WflowOutputGridComponent`
`model.output_scalar`	`WflowOutputScalarComponent`
`model.output_csv`	`WflowOutputCsvComponent`

I/O methods#

If you are using python, you can read and write the different model components using the methods below.

`WflowSbmModel.build`(*[, write])	Single method to build a model from scratch based on settings in steps.
`WflowSbmModel.update`(*[, model_out, write, ...])	Single method to update a model based the settings in steps.
`WflowSbmModel.read`([config_filename, ...])	Read components from disk.
`WflowSbmModel.write`([config_filename, ...])	Write the complete model schematization and configuration to file.

Component-level API#

The table below summarizes the important methods and attributes for each component. These allow for fine-grained reading, writing, modification, and inspection of component data. They are particularly useful when working interactively in Python, for example when updating specific configuration parameters, clipping static maps, or inspecting the forcing data.

Each component exposes a data attribute, which holds the underlying model data (e.g. dict, xarray.Dataset, or geopandas.GeoDataFrame), and supports a common set of I/O and manipulation methods such as read(), write(), and set().

For general I/O at the model level, refer to: WflowSbmModel and its read() and write() methods.

The following table provides a detailed overview of the component-level APIs.

Component class	Methods	Attributes
`WflowConfigComponent`	`read()`, `write()`, `get_value()`, `set()`, `update()`,	`data`
`WflowStaticmapsComponent`	`read()`, `write()`, `set()`, `clip()`,	`data`
`WflowGeomsComponent`	`read()`, `write()`, `get()`, `set()`, `pop()`,	`data`
`WflowForcingComponent`	`read()`, `write()`, `set()`, `clip()`,	`data`
`WflowStatesComponent`	`read()`, `write()`, `set()`, `clip()`,	`data`
`WflowTablesComponent`	`read()`, `write()`, `set()`,	`data`
`WflowOutputGridComponent`	`read()`, `write()`, `set()`,	`data`
`WflowOutputScalarComponent`	`read()`, `write()`, `set()`,	`data`
`WflowOutputCsvComponent`	`read()`, `write()`, `set()`,	`data`

Attributes#

Other useful model attributes if you are using python:

`WflowSbmModel.crs`	Returns coordinate reference system embedded in region.
`WflowSbmModel.root`	Model root
`WflowSbmModel.flwdir`	Return the pyflwdir.FlwdirRaster object parsed from wflow ldd.
`WflowSbmModel.basins`	Returns a basin(s) geometry as a geopandas.GeoDataFrame.
`WflowSbmModel.rivers`	Return a river geometry as a geopandas.GeoDataFrame.