hydromt-wflow 1.1.0

What is the HydroMT-Wflow plugin

HydroMT (Hydro Model Tools) is an open-source Python package that facilitates 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 analyze model results once the simulation has finished. This plugin provides an implementation of the model API for the Wflow model.

Why HydroMT-Wflow?

Setting up distributed hydrological models typically requires many (manual) steps to process input data and might therefore be time consuming and hard to reproduce. Especially improving models based on global-local geospatial datasets, which are rapidly becoming available at increasingly high resolutions, might be challenging. HydroMT-Wflow aims to make the Wflow model building and updating processes fast, modular and reproducible and to facilitate the analysis of the model results.

How to use HydroMT-Wflow?

The HydroMT-Wflow plugin can be used as a command line application, which provides commands to build, update (including clip) a Wflow model with a single line, or from python to exploit its rich interface. You can learn more about how to use HydroMT-Wflow in its online documentation. For a smooth installing experience we recommend installing HydroMT-Wflow and its dependencies from conda-forge in a clean environment, see installation guide.

How to cite?

For publications, please cite our work using the DOI provided in the Zenodo badge that points to the latest release.

How to contribute?

If you find any issues in the code or documentation feel free to leave an issue on the github issue tracker. You can find information about how to contribute to the HydroMT project at our contributing page.

HydroMT seeks active contribution from the (hydro) geoscientific community. So far, it has been developed and tested with a range of Deltares models, but we believe it is applicable to a much wider set of geoscientific models and are happy to discuss how it can be implemented for your model.

Changelog

See the full changelog for a complete list of changes and release notes.

Dependencies

HydroMT-Wflow builds on the HydroMT core and relies on several excellent open-source packages for geospatial and scientific computing, including:

• Core Scientific & Data libraries: hydromt, xarray, numpy, pandas, scipy, numba, dask, bottleneck, cftime, gwwapi, hydroengine, pyflwdir,

• Geospatial libraries: geopandas, shapely, rasterio, rioxarray, pyproj, pyogrio, cligj

• Configuration, Validation & CLI Tools: attrs, click, click-plugins, pydantic, pydantic-core, pyyaml, typing-inspection, importlib-metadata

• File IO, Storage & Networking: fsspec, netcdf4, tomli, tomli-w, requests, universal-pathlib, urllib3, pooch, pyet, wradlib

• Utilities & Support libraries: colorama, six, packaging, platformdirs, partd, toolz

• Other dependencies: affine, annotated-types, certifi, charset-normalizer, cloudpickle, crc32c, donfig, idna, llvmlite, locket, mercantile, numcodecs, pystac, pyparsing, python-dateutil, pytz, typing-extensions, tzdata, xmltodict, zarr, zipp

• Examples & Visualization: cartopy, jupyterlab, nbconvert, notebook