User guide#
HydroMT (Hydro Model Tools) is an open-source Python package that facilitates the process of building and analysing 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. As such it is an interface between user, data and models.
A sequence describing how to prepare ready-to-run models using HydroMT#
In short the most common usage of hydromt is to build/update models via the following steps (see also the quick overview on how to use HydroMT):
Collect and catalog raw input data (e.g. DEM, land use, soil, climate, etc.)
Prepare a HydroMT configuration file to let HydroMT know which part of your model you wish to prepare, how and using which data (e.g. DEM from SRTM, MERIT Hydro, Copernicus or other source)
Run HydroMT to do all the data reading and processing for you either via the command line interface or via the Python API.
In this user guide, we will go through the different steps of the workflow and the different functionalities of HydroMT. We will also provide examples and tutorials to help you get started with HydroMT.
The user guide is organized as follows:
Introduction to HydroMT: A brief introduction to HydroMT and its main functionalities.
Quick overview: A quick overview on how to use HydroMT.
HydroMT command line interface: A detailed description of the command line interface.
HydroMT Python API: A detailed description of the Python API (advanced users).
Working with data in HydroMT: A detailed section to go through how HydroMT interacts with raw input data through its DataCatalog.
Working with models in HydroMT: A detailed section to go through how to prepare and interact with models using HydroMT.
Methods and workflows: A detailed section to go through the different methods and workflows available in HydroMT (advanced or python users).
One final remark: because each model is unique at least in its input file format (e.g. netCDF, text, binary, etc.), HydroMT is usually used in combination with a plugin. These plugins are here to define model specific file formats and readers/writers. You can find the list of available plugins in the plugins section.