Working with models in HydroMT#

High level functionality#

HydroMT has the following high-level functionality for setting up models from raw data or adjusting models:

building a model: building a model from scratch.
updating a model: adding or changing model components of an existing model.
clipping a model: changing the spatial domain of an existing model (e.g. select subbasins from a larger model).

The building and clipping methods required the user to provide a region of interest. HydroMT provides several options to define a region based on a geospatial or hydrographic region.

The exact process of building or updating a model can be configured in a single configuration .ini file. This file describes the full pipeline of model methods and their arguments. The methods vary for the different model Plugins and are documented for each at their respective documentation websites.

Model data components#

Model data components are data attributes which together define a model instance and are identical for all models. Each component represents a specific model component and is parsed to a specific Python data object that should adhere to certain specifications. An overview is given below.

Component	Explanation	API
Staticmaps	Static gridded data	`staticmaps` `set_staticmaps()` `read_staticmaps()` `write_staticmaps()`
Staticgeoms	Static vector data	`staticgeoms` `set_staticgeoms()` `read_staticgeoms()` `write_staticgeoms()`
Forcing	(Dynamic) forcing data (meteo or hydrological for example)	`forcing` `set_forcing()` `read_forcing()` `write_forcing()`
Results	Model output	`results` `set_results()` `read_results()`
States	Initial model conditions	`states` `set_states()` `read_states()` `write_states()`
Config	Settings for the model kernel simulation	`config` `set_config()` `read_config()` `write_config()`

Supported models#

For a list of supported models see the Plugins page.