Skip to main content

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. License

Overview

HydroFlows aims to make it easy to create validated workflows using standardized methods and parse these to a workflow engine. In HydroFlows, a workflow consists of methods that are chained together by connecting the file-based output of one method to the input of another. While HydroFlows can also execute the workflows, it is recommended to use a workflow engine to manage the execution of the workflows and to take advantage of the parallelization, scalability, and caching features of these engines. Currently we support Snakemake or engines that support the Common Workflow Language (CWL).

Why HydroFlows?

It can be challenging to create workflows, especially when these should be modular and flexible. With HydroFlows, users can create workflows in a Python script and don’t need to learn a new language or syntax. Using a IDE such as VSCode method in- and outputs can easily be discovered, making it easy to chain methods together in a workflow. Furthermore, method parameters are directly validated at initialization and connections between methods are validated when adding them to the workflow. All these features make it easy to create and maintain workflows compared to other workflow engines.

HydroFlows for flood risk assessments

Currently, the available methods in HydroFlows are focused on flood risk assessments. Methods include the automated setup of physics-based models such as Wflow and SFINCS, statistical analysis, and impact assessments using Delft-FIAT. Many methods build on HydroMT and are backed up by a large stack of state-of-art global datasets to enable rapid assessments anywhere globally. As the workflows are fully automated these can easily be replaced by local data where available. The final outcomes of the HydroFlows flood risk workflows are flood hazard and risk maps and statistics. In addition a FloodAdapt instance can be created from the built models and event sets.

Acknowledgements

This library was created as part of the Horizon Europe UP2030 (Grant Agreement Number 101096405) and InterTwin (Grant Agreement Number 101058386) projects.

License

MIT license, see the LICENSE file for details.

Metadata

Release files for hydroflows 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hydroflows 0.1.0
File Size Uploaded
hydroflows-0.1.0.tar.gz 200.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hydroflows 0.1.0
File Interpreter ABI Platform
hydroflows-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 448.4 kB

Release files / hydroflows-0.1.0.tar.gz

Download URL hydroflows-0.1.0.tar.gz
Size 200.2 kB
Tags Source
SHA-256 checksum
How to use checksums
45389248b0cf380fba4ce173ab75f2c907c1e5af09d01d143574730c9be8d30a
BLAKE2b-256 checksum
How to use checksums
263590ccb74432dadbe9783f0b801bb2a2751ab7166cb251371690a87af23921
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.32.3

Release files / hydroflows-0.1.0-py3-none-any.whl

Download URL hydroflows-0.1.0-py3-none-any.whl
Size 248.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
da8e49289a0386d55467144d2e61fee589b714f7aed8b8e7862552058d5ad873
BLAKE2b-256 checksum
How to use checksums
3d6b4895125a414304c43571c9550452c7e6c73204a9858520e598de8ef70329
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.32.3

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page