Components

The hydromt_wflow.components module defines reusable data container classes that represent configuration, static maps, states, outputs, and other model 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().

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.

WflowConfigComponent	Manage the wflow TOML configuration file for model simulations/settings.
WflowStaticmapsComponent	Wflow staticmaps component.
WflowForcingComponent	Wflow forcing component.
WflowGeomsComponent	Wflow Geoms Component to manage spatial geometries.
WflowStatesComponent	ModelComponent class for Wflow states.
WflowTablesComponent	Wflow specific tables component.
WflowOutputGridComponent	ModelComponent class for Wflow netcdf_grid output.
WflowOutputScalarComponent	ModelComponent class for Wflow netcdf_scalar output.
WflowOutputCsvComponent	ModelComponent class for Wflow csv output.