DelwaqModel

The DelwaqModel class represents the D-Water Quality fate and transport model implementation.

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

Delwaq model class.

Setup methods

DelwaqModel.setup_config(data)	Set the config dictionary at key(s) with values.
DelwaqModel.setup_basemaps(region[, mask, ...])	Prepare delwaq schematization using the hydromodel region and resolution.
DelwaqModel.setup_monitoring([mon_points, ...])	Prepare Delwaq monitoring points and areas options.
DelwaqModel.setup_staticdata_from_rasterdataset(...)	Add data variable(s) from raster_data to grid component.
DelwaqModel.setup_hydrology_forcing(...[, ...])	Prepare Delwaq hydrological fluxes.
DelwaqModel.setup_sediment_forcing(...[, ...])	Prepare Delwaq sediment fluxes.
DelwaqModel.setup_climate_forcing(...[, ...])	Prepare Delwaq climate fluxes.

Components

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

Model Component	Component class
model.config	DelwaqConfigComponent
model.staticdata	DelwaqStaticdataComponent
model.pointer	DelwaqPointerComponent
model.forcing	DelwaqForcingComponent
model.hydromaps	DelwaqHydromapsComponent
model.geoms	GeomsComponent

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
DelwaqConfigComponent	read(), write(), get_value(), set(), update(),	data
DelwaqStaticdataComponent	read(), write(), set(),	data
DelwaqPointerComponent	read(), write(), set(),	data
DelwaqForcingComponent	read(), write(), set(),	data
DelwaqHydromapsComponent	read(), write(), set(),	data

The GeomsComponent is inherited from HydroMT core and documented in hydromt.model.components.GeomsComponent

I/O methods

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

DelwaqModel.build(*[, write])	Single method to build a model from scratch based on settings in steps.
DelwaqModel.update(*[, model_out, write, ...])	Single method to update a model based the settings in steps.
DelwaqModel.read()	Read the complete model schematization and configuration from file.
DelwaqModel.write()	Write the complete model schematization and configuration to file.
DelwaqModel.write_waqgeom()	Write Delwaq netCDF geometry file (config/B3_waqgeom.nc).

Attributes

DelwaqModel.crs	Returns coordinate reference system embedded in region.
DelwaqModel.root	Model root
DelwaqModel.basins	Derive basins from geoms or hydromaps.
DelwaqModel.nrofseg	Fast accessor to nrofseg property of pointer.
DelwaqModel.nrofexch	Fast accessor to nrofexch property of pointer.
DelwaqModel.surface_water	Fast accessor to surface_water name property of pointer.
DelwaqModel.fluxes	Fast accessor to fluxes property of pointer.