Unified Framework for Hydrology

The Python package unifhy (Unified Framework for Hydrology) is a hydrological modelling framework which combines interchangeable modelling components for the surface layer, subsurface, and open water parts of the terrestrial water and nutrient cycles. By two-way coupling these six components, the framework provides a fully functional model for simulating the terrestrial water cycle. It is designed to foster collaborations between land surface, hydrological, and groundwater modelling communities by structuring their interactions around standardised interfaces between the components.

Fig. 1: Diagram of the Modelling Framework Blueprint for unifhy.

Getting started

Learn how to get unifhy.

Installation

Learn how to use unifhy.

Tutorial

Contribute to unifhy.

Contributor Guide

Documentation

The documentation features three guides for various target audiences:

• User Guide
  • Installation
  • Tutorial
  • Files
  • Support

• Contributor Guide
  • Development
  • Packaging
  • Sharing

• Developer Guide
  • Adding new transfers
  • Adding new Components
  • Development Guidance

The documentation lists the modelling components currently available in the framework:

• Science Library
  • Surface Layer Components
  • Sub-Surface Components
  • Open Water Components
  • Nutrient Surface Layer Components
  • Nutrient SubSurface Components
  • Nutrients Open Water Components

The Application Programming Interface (API) for the framework is also documented:

• API Reference
  • Model
  • Components
  • Time
  • Space
  • Data

• Change Log
• Licence

Acknowledgements

The development of this framework is funded by the NERC Hydro-JULES programme (NE/S017380/1).