unifhy

A Unified Framework for Hydrology

https://github.com/unifhy-org/unifhy

Science Score: 64.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
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    2 of 5 committers (40.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.2%) to scientific vocabulary

Keywords

hydrology land modelling modular
Last synced: 6 months ago · JSON representation ·

Repository

A Unified Framework for Hydrology

Basic Info
Statistics
  • Stars: 13
  • Watchers: 2
  • Forks: 5
  • Open Issues: 31
  • Releases: 3
Topics
hydrology land modelling modular
Created about 6 years ago · Last pushed 10 months ago
Metadata Files
Readme Changelog Citation Zenodo

README.rst

Unified Framework for Hydrology
-------------------------------

.. image:: https://img.shields.io/pypi/v/unifhy?style=flat-square
   :target: https://pypi.python.org/pypi/unifhy
   :alt: PyPI Version
.. image:: https://img.shields.io/badge/dynamic/json?url=https://zenodo.org/api/records/4726695&label=doi&query=doi&style=flat-square
   :target: https://zenodo.org/badge/latestdoi/234523723
   :alt: DOI
.. image:: https://img.shields.io/github/license/unifhy-org/unifhy?style=flat-square
   :target: https://opensource.org/licenses/BSD-3-Clause
   :alt: Licence
.. image:: https://img.shields.io/badge/fair-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B-yellow?style=flat-square
   :target: https://fair-software.eu
   :alt: FAIR Software Compliance
.. image:: https://img.shields.io/github/actions/workflow/status/unifhy-org/unifhy/basic_tests.yml?style=flat-square&label=tests
   :target: https://github.com/unifhy-org/unifhy/actions/workflows/basic_tests.yml
   :alt: Tests Status

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.

.. end here for docs

More details can be found in the online documentation accessible at
``_.

Owner

  • Name: Unified Framefork for Hydrology - Community Organisation
  • Login: unifhy-org
  • Kind: organization
  • Email: hydrojules@ceh.ac.uk
  • Location: UK

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Unified Framework for Hydrology
message: ' If you use this software, please cite it using the metadata from this file (CITATION.cff)'
type: software
authors:
  - given-names: Matt James
    family-names: Dalle Piagge
    email: matbro@ceh.ac.uk
    affiliation: UKCEH
    orcid: 'https://orcid.org/0000-0003-1127-0279'
  - given-names: Thibault
    family-names: Hallouin
    affiliation: INRAE
    orcid: 'https://orcid.org/0000-0003-0144-2989'
  - given-names: Richard J.
    family-names: Ellis
    email: rjel@ceh.ac.uk
    affiliation: UKCEH
    orcid: 'https://orcid.org/0000-0001-9667-7478'
identifiers:
  - type: doi
    value: 10.5281/zenodo.4726695
    description: Latest-version DOI
abstract: >-
  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 cycle. By two-way coupling these three
  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.
keywords:
  - modelling
  - framework
  - modelling framework
  - model framework
  - hydrology
  - unifhy
  - integrated modelling
  - coupled modelling
license: BSD-3-Clause

GitHub Events

Total
  • Watch event: 1
  • Member event: 1
  • Issue comment event: 3
  • Push event: 5
Last Year
  • Watch event: 1
  • Member event: 1
  • Issue comment event: 3
  • Push event: 5

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 661
  • Total Committers: 5
  • Avg Commits per committer: 132.2
  • Development Distribution Score (DDS): 0.207
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Thibault Hallouin t****n@u****e 524
Thibault Hallouin t****n@n****k 80
Thibault Hallouin t****n@g****m 32
github-actions[bot] g****]@u****m 13
Thibault Hallouin t****n@r****k 12
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 73
  • Total pull requests: 33
  • Average time to close issues: 4 months
  • Average time to close pull requests: 11 days
  • Total issue authors: 5
  • Total pull request authors: 3
  • Average comments per issue: 1.19
  • Average comments per pull request: 0.79
  • Merged pull requests: 31
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 3
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.33
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
  • ThibHlln (59)
  • mattjbr123 (10)
  • rich-HJ (2)
  • Mark-D-Smith (1)
  • wknoben (1)
Pull Request Authors
  • ThibHlln (28)
  • mattjbr123 (6)
  • dependabot[bot] (2)
Top Labels
Issue Labels
functionality (23) bug (12) enhancement (10) documentation (6) science (5) question (4) invalid (3) performance (3) CI (1)
Pull Request Labels
documentation (3) dependencies (2) code tidying up (1) functionality (1) enhancement (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 68 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 5
  • Total maintainers: 3
pypi.org: unifhy

Unified Framework for Hydrology

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 68 Last month
Rankings
Dependent packages count: 7.4%
Forks count: 14.3%
Stargazers count: 18.5%
Average: 20.1%
Dependent repos count: 22.2%
Downloads: 37.9%
Maintainers (3)
Last synced: 6 months ago
conda-forge.org: unifhy

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 cycle. It is designed to foster collaborations between land surface, hydrological, and groundwater modelling communities.

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 34.0%
Average: 48.4%
Dependent packages count: 51.2%
Forks count: 51.6%
Stargazers count: 57.0%
Last synced: 6 months ago

Dependencies

requirements-docs.txt pypi
  • gitpython *
  • pydata-sphinx-theme ==0.6.3
  • sphinx ==4.2.0
  • sphinx-panels *
requirements-tests.txt pypi
  • cython * test
requirements.txt pypi
  • cf-python >=3.11.0
  • cftime *
  • cfunits *
  • esmpy *
  • netCDF4 >=1.5
  • numpy >=1.16
  • pyproj >=3.0
  • pyyaml >=5.3
.github/workflows/advanced_tests.yml actions
  • actions/checkout v2 composite
  • conda-incubator/setup-miniconda v2 composite
.github/workflows/basic_tests.yml actions
  • actions/checkout v2 composite
  • conda-incubator/setup-miniconda v2 composite
.github/workflows/build_docs.yml actions
  • actions/checkout v2 composite
  • actions/download-artifact v2 composite
  • actions/upload-artifact v2 composite
  • conda-incubator/setup-miniconda v2 composite
pyproject.toml pypi
setup.py pypi
tests/tests/components/openwater/dummyc/setup.py pypi
tests/tests/components/subsurface/dummyc/setup.py pypi
tests/tests/components/surfacelayer/dummyc/setup.py pypi