Tip

For an interactive online version click here: Binder badge

Example: Working with models in Python#

The main feature of HydroMT is to facilitate the process of building and analyzing spatial geoscientific models with a focus on water system models. It does so by automating the workflow to go from raw data to a complete model instance which is ready to run and to analyse model results once the simulation has finished.

This notebook will explore how to work with HydroMT models in Python.

Available models and components in HydroMT#

To know which models are available within your active environment, you can use global PLUGINS variable in hydromt

[1]:

import hydromt

# generic model classes
print(f"Model classes: {hydromt.PLUGINS.model_summary()}")
# model classes from external plugin
print(f"Model components: {hydromt.PLUGINS.component_summary()}")

Model classes: Model plugins:
        - model (hydromt 1.0.1.dev0)
Model components: Component plugins:
        - ConfigComponent (hydromt 1.0.1.dev0)
        - DatasetsComponent (hydromt 1.0.1.dev0)
        - GeomsComponent (hydromt 1.0.1.dev0)
        - GridComponent (hydromt 1.0.1.dev0)
        - MeshComponent (hydromt 1.0.1.dev0)
        - SpatialDatasetsComponent (hydromt 1.0.1.dev0)
        - TablesComponent (hydromt 1.0.1.dev0)
        - VectorComponent (hydromt 1.0.1.dev0)

Model components#

HydroMT defines any model through the model-agnostic Model API based on several general model components and computational unit components TBC