cmf

A programming library to create hydrological models, which are highly modular and connectible to other models developed using a multiple hypotheses background and is based on the finite volume method.
https://github.com/philippkraft/cmf

Category: Hydrosphere
Sub Category: Freshwater and Hydrology

Keywords

hydrological-model hydrology water-quality

Keywords from Contributors

observatory odmf

Last synced: about 5 hours ago
JSON representation

Repository metadata

Catchment Modelling Framework, a hydrologic modelling toolbox

README.rst

          |logo|

|lic| |zeno| |pypi| |github-action|

.. |logo| image:: https://raw.githubusercontent.com/philippkraft/cmf/master/documentation/media/cmf-logo-klein-2018.png
    :target: https://philippkraft.github.io/cmf

.. |lic| image:: https://raw.githubusercontent.com/philippkraft/cmf/master/documentation/media/license-GPLv3-green.svg?sanitize=true
    :target: https://opensource.org/licenses/GPL-3.0
    
.. |zeno| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1125290.svg
   :target: https://doi.org/10.5281/zenodo.1125290
   
.. |pypi| image:: https://badge.fury.io/py/cmf.svg
    :target: https://pypi.python.org/pypi/cmf/

.. |github-action| image:: https://github.com/philippkraft/cmf/actions/workflows/wheel.yml/badge.svg
    :target: https://github.com/philippkraft/cmf/actions/workflows/wheel.yml

Modelling water and solute fluxes
===================================

cmf is a programming library to create hydrological models, which are highly modular and connectible to other
models developed using a `multiple hypotheses background `_
and is based on the `finite volume method `_
Although written in C++, its primary usage is to be compiled
as an extension to other programming languages, using SWIG. Researchers can build individual models,
targeting their scientific question by using the library objects like water storages, boundary conditions,
fluxes and solvers. cmf uses the finite volume method to set up a wide range of models of water flow through
your study area. Resulting models can range from **lumped conceptual models** to **fully distributed darcian models**
and everything in between.

*cmf* is published as free software under GPLv3. (c) 2007-2017 by Philipp Kraft and the
Institute of Landscape Ecology and Resources Management, Justus-Liebig Universität Gießen.

Documentation
---------------
Can be found here: https://philippkraft.github.io/cmf

Development
--------------
You can join the development or report bugs at Github:

.. image:: https://img.shields.io/github/release/philippkraft/cmf.svg?logo=github
    :target: https://github.com/philippkraft/cmf


Publications
------------

The basic publication of cmf is:
    Kraft, P., Vaché, K.B., Frede, H.-G. Breuer, L. 2011. A hydrological programming language extension for integrated
    catchment models, Environmental Modelling & Software, `doi: 10.1016/j.envsoft.2010.12.009 `_


`Published applications `_






        

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 2 days ago

Total Commits: 2,332
Total Committers: 24
Avg Commits per committer: 97.167
Development Distribution Score (DDS): 0.521

Commits in past year: 8
Committers in past year: 2
Avg Commits per committer in past year: 4.0
Development Distribution Score (DDS) in past year: 0.125

Name Email Commits
philipp 1****t 1118
philippkraft p****t@u****e 406
no_author n****r@n****r 128
Chris c****d 119
ina i****a@a****0 116
martin m****n@a****0 79
nadine n****e@a****0 72
konrad 1****n 63
david d****d@a****0 60
bjoern b****n@a****0 38
laura l****a@a****0 32
karima k****a@a****0 30
Andrea A****a@a****0 16
Florian Jehn u****0@g****e 14
tobias t****a 13
Allan Karlson b****r@g****e 9
David Windhorst d****t@u****e 5
Florian Jehn f****n@u****e 5
Philipp Kraft p****t@e****e 3
philipp P****t 2
Benjamin Manns b****s@m****e 1
Ina Plesca i****a@u****e 1
Steffen Klatt s****t@k****u 1
steffen s****n@a****0 1

Committer domains:


Issue and Pull Request metadata

Last synced: 10 months ago

Total issues: 74
Total pull requests: 14
Average time to close issues: 5 months
Average time to close pull requests: 16 days
Total issue authors: 11
Total pull request authors: 4
Average comments per issue: 1.5
Average comments per pull request: 0.79
Merged pull request: 11
Bot issues: 0
Bot pull requests: 0

Past year issues: 3
Past year pull requests: 2
Past year average time to close issues: N/A
Past year average time to close pull requests: 20 days
Past year issue authors: 2
Past year pull request authors: 1
Past year average comments per issue: 0.33
Past year average comments per pull request: 0.0
Past year merged pull request: 2
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/philippkraft/cmf

Top Issue Authors

  • philippkraft (50)
  • smultsch (8)
  • florianjehn (4)
  • cojacoo (3)
  • richardneumann84 (3)
  • DWindhorst (1)
  • Stefan-Ju (1)
  • kbstn (1)
  • ocni-dtu (1)
  • starboy1986 (1)

Top Pull Request Authors

  • philippkraft (5)
  • bees4ever (5)
  • florianjehn (3)
  • DWindhorst (1)

Top Issue Labels

  • C++ (28)
  • enhancement (20)
  • documentation (15)
  • bug (13)
  • python (11)
  • swig (9)
  • cleaning (8)
  • help wanted (4)
  • numerical performance (3)
  • build system (1)
  • question (1)
  • wontfix (1)
  • invalid (1)

Top Pull Request Labels

  • python (1)
  • enhancement (1)
  • C++ (1)

Package metadata

pypi.org: cmf

Catchment Modelling Framework - A hydrological modelling toolkit

  • Homepage: https://www.uni-giessen.de/hydro/download
  • Documentation: https://cmf.readthedocs.io/
  • Licenses: GPLv3+
  • Latest release: 2.0.2 (published 8 months ago)
  • Last Synced: 2026-07-05T10:50:46.674Z (2 days ago)
  • Versions: 21
  • Dependent Packages: 0
  • Dependent Repositories: 5
  • Downloads: 586 Last month
  • Docker Downloads: 0
  • Rankings:
    • Dependent repos count: 6.777%
    • Dependent packages count: 7.373%
    • Forks count: 8.929%
    • Stargazers count: 9.344%
    • Average: 10.255%
    • Downloads: 18.85%
  • Maintainers (2)

Dependencies

setup.py pypi
requirements.txt pypi
  • cmake >=3.13.0
  • numpy >=1.14
  • scipy >=1.0
  • shapely >=1.5.0
  • wheel *
.github/workflows/wheel.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
pyproject.toml pypi

Score: 13.880736342881981