matilda

Tool for modeling water resources in glacierized catchments. Combines a temperature-index melt model with the conceptual catchment model HBV and a parameterized glacier area/volume re-scaling routine.

https://github.com/cryotools/matilda

Science Score: 77.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 25 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    3 of 9 committers (33.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.7%) to scientific vocabulary

Keywords

climate earth-science glaciers hbv hbv-model hydrology matilda melt modeling python spotpy
Last synced: 6 months ago · JSON representation ·

Repository

Tool for modeling water resources in glacierized catchments. Combines a temperature-index melt model with the conceptual catchment model HBV and a parameterized glacier area/volume re-scaling routine.

Basic Info
  • Host: GitHub
  • Owner: cryotools
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 220 MB
Statistics
  • Stars: 19
  • Watchers: 3
  • Forks: 1
  • Open Issues: 0
  • Releases: 4
Topics
climate earth-science glaciers hbv hbv-model hydrology matilda melt modeling python spotpy
Created over 4 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation Zenodo

README.md

MATILDA: Modeling wATer resources In gLacierizeD cAtchments

DOI Documentation Status

MATILDA is a Python-based modeling framework for simulating water resources in glacierized catchments. This repository contains the core routines of the comprehensive MATILDA-Online workflow:

  1. The matilda.core module combines a temperature-index melt model with the HBV model for hydrological simulations.
  2. The matilda.mspot_glacier module provides a parameter optimization routine using the spotpy library.

While MATILDA can be used as a stand-alone model, the MATILDA-Online workflow provides comprehensive tools for data acquisition, pre- and post-processing with detailed documentation.


Repository Structure

. ├── Example │ ├── example_workflow.py # Example script for running MATILDA │ ├── forcing_data.csv # Input data for example workflow │ └── runoff_data.csv # Observed runoff data ├── matilda │ ├── core.py # MATILDA core routines │ └── mspot_glacier.py # Parameter optimization routines ...


Installation

The tool's dependencies are set to integrate with MATILDA-Online. It requires Python 3.11 and the following libraries: - xarray - numpy - pandas - matplotlib - scipy - datetime - hydroeval - HydroErr - plotly - spotpy - pyyaml

The MATILDA package and it's dependencies can be installed on your local machine using pip or a similar package manager. You can either install the package by using the link to this repository: pip install git+https://github.com/cryotools/matilda.git ...or clone this repository to your local machine, navigate to the top-level directory and use it: ``` pip install .

```

Usage

A detailed walkthrough of the proposed modeling workflow and calibration strategy can be found at the MATILDA Online Webpage. For a quick start to the stand-alone model, see the application example and use the following guidelines.

Forcing Data

The minimum input is a CSV file containing time series of air temperature (°C or K), total precipitation (mm), and (if available) evapotranspiration (mm) data in the format shown below. If evapotranspiration is not provided, it is estimated from air temperature according to Oudin et.al. 2010. A series of discharge observations (mm) is used to calibrate the model. If no discharge data are provided, the model runs with default parameters. All datasets require daily resolution.

| TIMESTAMP | T2 | RRR | PE | |---------------------|-------|------|------| | 2011-01-01 00:00:00 | -18.2 | 0.00 | 0.00 | | 2011-01-01 01:00:00 | -18.3 | 0.1 | 0.00 | | 2011-01-01 02:00:00 | -18.2 | 0.1 | 0.00 | | ... | ... | ... | ... |

| Date | Qobs | |------------|------| | 2011-01-01 | 0.17 | | 2011-01-01 | 0.19 | | ... | ... |

The forcing data are scaled to the mean elevations of the glacierized and ice-free subcatchments, respectively, using linear lapse rates. Reference elevations must be provided for the input data, the entire catchment, and the glacierized fraction. Automated routines for catchment delineation and public data download can be found in the MATILDA Online workflow.

Glacier Data

To apply the Δh parameterization of Huss and Hock 2015 within the DDM routine to calculate glacier evolution over the study period, you need to provide data on the initial glacier cover. The routine requires an initial glacier profile containing the spatial distribution of ice over elevation bands at the beginning of the study period in the form of a dataframe:

| Elevation | Area | WE | EleZone | |-----------|-------|-----------|---------| | 3720 | 0.005 | 10786.061 | 3700 | | 3730 | 0.001 | 13687.801 | 3700 | | 3740 | 0.001 | 12571.253 | 3700 | | 3750 | 0.002 | 12357.987 | 3800 | | .. | ... | ... | ... |

  • Elevation - elevation of each band (10 m intervals recommended)
  • Area - glacierized area in each band as a fraction of the total catchment area (column sum is the glacierized fraction of the total catchment)
  • WE - ice thickness in mm w.e.
  • EleZone - combined bands across 100-200 m.

Parameter List

MATILDA has 21 non-optional parameters, most of which are HBV standard parameters.

| Parameter | Description | Unit | Default Value | |-----------------------|--------------------------------------------------------------|-----------------------|-----------------------| | $\text{lr}{\text{temp}}$ | Temperature lapse rate | °C m⁻¹ | -0.006 | | $\text{lr}{\text{prec}}$ | Precipitation lapse rate | mm m⁻¹ | 0 | | $\text{PCORR}$ | Precipitation correction factor | - | 1.0 | | $\text{TT}{\text{snow}}$ | Threshold temperature for snow | °C | 0 | | $\text{TT}{\text{diff}}$ | Temperature range for rain-snow transition | °C | 2 | | $\text{SFCF}$ | Snowfall correction factor | - | 0.7 | | $\text{CFMAX}{\text{snow}}$ | Melt factor for snow | mm °C⁻¹ day⁻¹ | 5 | | $\text{CFMAX}{\text{rel}}$ | Melt factor for ice relative to snow | - | 2 | | $\text{CWH}$ | Water holding capacity of snowpack | - | 0.1 | | $\text{CFR}$ | Refreezing coefficient | - | 0.15 | | $\text{AG}$ | Control parameter of the glacier storage-release scheme | - | 0.7 | | $\text{BETA}$ | Shape coefficient for soil moisture routine | - | 1.0 | | $\text{CET}$ | Correction factor for evapotranspiration | - | 0.15 | | $\text{FC}$ | Field capacity of soil | mm | 250 | | $\text{LP}$ | Fraction of field capacity for maximum evapotranspiration | - | 0.7 | | $\text{K}0$ | Recession coefficient for surface flow | day⁻¹ | 0.055 | | $\text{K}1$ | Recession coefficient for intermediate groundwater flow | day⁻¹ | 0.055 | | $\text{K}_2$ | Recession coefficient for deep groundwater flow | day⁻¹ | 0.04 | | $\text{PERC}$ | Percolation rate from upper to lower groundwater reservoir | mm day⁻¹ | 1.5 | | $\text{UZL}$ | Threshold for quick flow from upper zone | mm | 120 | | $\text{MAXBAS}$ | Length of triangular routing function | day | 3.0 |


Authors

  • Phillip Schuster - Lead - (https://github.com/phiscu)
  • Alexander Georgi - Visualization and Integration with MATILDA-Online - (https://github.com/geoalxx)
  • Ana-Lena Tappe - Initial work - (https://github.com/anatappe)

See also the list of contributors who participated in the initial project funded by the GIZ.

License

This project is licensed under the MIT License.


References

The development of MATILDA integrated several well-established hydrological and glacier modeling tools. References for the primary methods and libraries used in the model are listed below:

PyPDD (Temperature-Index Model):

LHMP and HBV Models:

Δh (delta-h) Parametrization:

SPOTPY (Parameter Optimization):

Owner

  • Name: CryoTools
  • Login: cryotools
  • Kind: organization

Scientific software tools to investigate the cryosphere - community driven, free, open source

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it using the following metadata."
title: "MATILDA: Modeling wATer resources In gLacierizeD cAtchments"
version: "1.0.1"
doi: "10.5281/zenodo.14267360"
date-released: "2025-06-21"
authors:
  - family-names: "Schuster"
    given-names: "Phillip"
    orcid: "0000-0002-0794-6689"
    affiliation: "Humboldt-Universität zu Berlin, Geography Department"
  - family-names: "Georgi"
    given-names: "Alexander"
    orcid: "0009-0000-9465-6761"
    affiliation: "Humboldt-Universität zu Berlin, Geography Department"
  - family-names: "Tappe"
    given-names: "Ana-Lena"
    affiliation: "Humboldt-Universität zu Berlin, Geography Department"
keywords:
  - glacier modeling
  - hydrology
  - water resources
  - temperature-index melt model
  - HBV model
  - parameter optimization
license: "MIT"
repository-code: "https://github.com/cryotools/matilda"
url: "https://matilda-online.github.io/jbook/"
abstract: >
  MATILDA is a Python-based modeling framework designed to simulate water 
  resources in glacierized catchments. It combines a temperature-index melt 
  model with the conceptual catchment model HBV and incorporates a 
  parameterized glacier area/volume re-scaling routine. 
  It also includes parameter optimization capabilities using the SPOTPY library.

GitHub Events

Total
  • Create event: 11
  • Issues event: 3
  • Release event: 4
  • Watch event: 5
  • Delete event: 8
  • Member event: 1
  • Issue comment event: 3
  • Push event: 52
  • Pull request event: 11
  • Fork event: 1
Last Year
  • Create event: 11
  • Issues event: 3
  • Release event: 4
  • Watch event: 5
  • Delete event: 8
  • Member event: 1
  • Issue comment event: 3
  • Push event: 52
  • Pull request event: 11
  • Fork event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 682
  • Total Committers: 9
  • Avg Commits per committer: 75.778
  • Development Distribution Score (DDS): 0.49
Past Year
  • Commits: 61
  • Committers: 3
  • Avg Commits per committer: 20.333
  • Development Distribution Score (DDS): 0.279
Top Committers
Name Email Commits
Phillip Schuster p****r@p****e 348
Ana-Lena Tappe a****e@h****e 141
Correct Name a****e@g****m 138
geoalxx a****1@g****e 23
hoepke m****n@g****e 12
Phillip Schuster p****r@g****e 11
Phillip Schuster s****h@m****r 6
Phillip Schuster s****h@l****s 2
Georgi a****i@s****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 4
  • Total pull requests: 14
  • Average time to close issues: 12 months
  • Average time to close pull requests: 8 minutes
  • Total issue authors: 3
  • Total pull request authors: 2
  • Average comments per issue: 1.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 14
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 7
  • Average time to close issues: about 18 hours
  • Average time to close pull requests: 16 minutes
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 3.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • phiscu (2)
  • LKPatel1 (1)
  • KReeves092 (1)
Pull Request Authors
  • phiscu (18)
  • geoalxx (2)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 6
proxy.golang.org: github.com/cryotools/matilda
  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago

Dependencies

matilda.egg-info/requires.txt pypi
  • HydroErr *
  • datetime *
  • hydroeval *
  • matplotlib *
  • numpy *
  • pandas *
  • plotly *
  • scipy *
  • xarray *
setup.py pypi
  • HydroErr *
  • datetime *
  • hydroeval *
  • matplotlib *
  • numpy *
  • pandas *
  • plotly *
  • scipy *
  • xarray *