earthkit-hydro¶
Important
This software is Incubating and subject to ECMWF’s guidelines on Software Maturity.
earthkit-hydro is a Python library for common hydrological functions. It is the hydrological component of earthkit [ECM22b].
Main Features¶
Catchment delineation
Catchment-based statistics
Directional flow-based accumulations
River network distance calculations
Upstream/downstream field propagation
Bifurcation handling
Custom weighting and decay support
Support for PCRaster, CaMa-Flood, HydroSHEDS, MERIT-Hydro and GRIT river network formats
Compatible with major array-backends: xarray, numpy, cupy, torch, jax, mlx and tensorflow
GPU support
Differentiable operations suitable for machine learning
Installation¶
Try it out! earthkit-hydro is readily available on PyPI.
pip install earthkit-hydro
Support¶
Have a feature request or found a bug? Feel free to open an issue.
Documentation¶
- User Guide
- Loading a river network
- Handling xarray and multiple array backends
- Raster and vector networks
- Flow accumulations
- Specifying locations
- Catchment delineation
- Catchment statistics
- Distance and length calculations
- Streamorder
- Subnetwork creation
- Integration with the earthkit system
- Migrating from PCRaster
- Tutorials
- API Reference
- Contributing
- Bibliography