NeuralHydrology --- A Python library for Deep Learning research in hydrology

NeuralHydrology --- A Python library for Deep Learning research in hydrology - Published in JOSS (2022)

https://github.com/neuralhydrology/neuralhydrology

Science Score: 100.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 5 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    3 of 19 committers (15.8%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Mathematics Computer Science - 84% confidence
Earth and Environmental Sciences Physical Sciences - 62% confidence
Artificial Intelligence and Machine Learning Computer Science - 60% confidence
Last synced: 4 months ago · JSON representation ·

Repository

Python library to train neural networks with a strong focus on hydrological applications.

Basic Info
Statistics
  • Stars: 462
  • Watchers: 29
  • Forks: 238
  • Open Issues: 7
  • Releases: 27
Created about 5 years ago · Last pushed 4 months ago
Metadata Files
Readme Contributing License Citation Codeowners

README.md

#

Python library to train neural networks with a strong focus on hydrological applications.

This package has been used extensively in research over the last years and was used in various academic publications. The core idea of this package is modularity in all places to allow easy integration of new datasets, new model architectures or any training-related aspects (e.g. loss functions, optimizer, regularization). One of the core concepts of this code base are configuration files, which let anyone train neural networks without touching the code itself. The NeuralHydrology package is built on top of the deep learning framework PyTorch, since it has proven to be the most flexible and useful for research purposes.

We (the AI for Earth Science group at the Institute for Machine Learning, Johannes Kepler University, Linz, Austria) are using this code in our day-to-day research and will continue to integrate our new research findings into this public repository.

Cite NeuralHydrology

In case you use NeuralHydrology in your research or work, it would be highly appreciated if you include a reference to our JOSS paper in any kind of publication.

bibtex @article{kratzert2022joss, title = {NeuralHydrology --- A Python library for Deep Learning research in hydrology}, author = {Frederik Kratzert and Martin Gauch and Grey Nearing and Daniel Klotz}, journal = {Journal of Open Source Software}, publisher = {The Open Journal}, year = {2022}, volume = {7}, number = {71}, pages = {4050}, doi = {10.21105/joss.04050}, url = {https://doi.org/10.21105/joss.04050}, }

Contact

For questions or comments regarding the usage of this repository, please use the discussion section on Github. For bug reports and feature requests, please open an issue on GitHub. In special cases, you can also reach out to us by email: neuralhydrology(at)googlegroups.com

Owner

  • Name: Neural Hydrology
  • Login: neuralhydrology
  • Kind: organization

AI 4 Earth Sciences research group, Institute of Machine Learning, JKU Linz

JOSS Publication

NeuralHydrology --- A Python library for Deep Learning research in hydrology
Published
March 04, 2022
Volume 7, Issue 71, Page 4050
Authors
Frederik Kratzert ORCID
Google Research
Martin Gauch ORCID
Institute for Machine Learning, Johannes Kepler University Linz, Linz, Austria
Grey Nearing ORCID
Google Research
Daniel Klotz ORCID
Institute for Machine Learning, Johannes Kepler University Linz, Linz, Austria
Editor
Jayaram Hariharan ORCID
Tags
python hydrology neural networks deep learning machine learning rainfall-runoff modeling

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Kratzert"
  given-names: "Frederik"
- family-names: "Gauch"
  given-names: "Martin"
- family-names: "Nearing"
  given-names: "Grey"
- family-names: "Klotz"
  given-names: "Daniel"
title: "NeuralHydrology --- A Python library for Deep Learning research in hydrology"
doi: 10.21105/joss.04050
url: "https://doi.org/10.21105/joss.04050"
preferred-citation:
  type: article
  authors:
  - family-names: "Kratzert"
    given-names: "Frederik"
  - family-names: "Gauch"
    given-names: "Martin"
  - family-names: "Nearing"
    given-names: "Grey"
  - family-names: "Klotz"
    given-names: "Daniel"
  doi: "10.21105/joss.04050"
  journal: "Journal of Open Source Software"
  publisher: 
    name: "The Open Journal"
  start: 4050 # First page number
  end: 4050 # Last page number
  title: "NeuralHydrology --- A Python library for Deep Learning research in hydrology"
  number: 71
  volume: 7
  year: 2022

GitHub Events

Total
  • Create event: 3
  • Release event: 1
  • Issues event: 18
  • Watch event: 89
  • Delete event: 2
  • Issue comment event: 31
  • Push event: 15
  • Pull request review event: 55
  • Pull request review comment event: 46
  • Pull request event: 31
  • Fork event: 47
Last Year
  • Create event: 3
  • Release event: 1
  • Issues event: 18
  • Watch event: 89
  • Delete event: 2
  • Issue comment event: 31
  • Push event: 15
  • Pull request review event: 55
  • Pull request review comment event: 46
  • Pull request event: 31
  • Fork event: 47

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 235
  • Total Committers: 19
  • Avg Commits per committer: 12.368
  • Development Distribution Score (DDS): 0.54
Past Year
  • Commits: 27
  • Committers: 11
  • Avg Commits per committer: 2.455
  • Development Distribution Score (DDS): 0.556
Top Committers
Name Email Commits
Frederik Kratzert k****t 108
Martin Gauch 1****m 86
Grey Nearing g****g@g****m 14
Daniel Klotz k****z@m****t 6
Scott Hamshaw s****w@u****u 3
Eduardo Acuna 6****a 2
Brandon Victor M****r@h****m 2
Jonathan Frame 4****e 2
Thomas Berends t****s@h****m 2
Andreu Bonet Pavia 1****s 1
BaptisteFrancois 3****s 1
Bevan Jenkins 2****j 1
Dan Kovacek d****n@d****m 1
Martijn Visser m****r@g****m 1
Sebastian Drost s****t@5****g 1
Sonam Lama 1****7 1
Tadd Bindas t****6@p****u 1
Vincent Cloarec v****c@g****m 1
XuHuanHydro 1****o 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 60
  • Total pull requests: 102
  • Average time to close issues: 29 days
  • Average time to close pull requests: 10 days
  • Total issue authors: 42
  • Total pull request authors: 25
  • Average comments per issue: 3.3
  • Average comments per pull request: 0.78
  • Merged pull requests: 79
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 9
  • Pull requests: 37
  • Average time to close issues: 9 days
  • Average time to close pull requests: 13 days
  • Issue authors: 7
  • Pull request authors: 13
  • Average comments per issue: 0.89
  • Average comments per pull request: 1.11
  • Merged pull requests: 20
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • shamshaw (4)
  • chuckaustin (3)
  • pedrozamboni (3)
  • Flash-Of-Thunder (3)
  • jmframe (3)
  • tommylees112 (3)
  • SebaDro (2)
  • Meelisha (2)
  • vlahm (2)
  • Kavindra95 (2)
  • jamesYu365 (2)
  • Sivarazadi (1)
  • ravindra801 (1)
  • Smile-L-up (1)
  • silencesoup (1)
Pull Request Authors
  • kratzert (39)
  • gauchm (16)
  • grey-nearing (11)
  • Multihuntr (6)
  • evanr1232 (4)
  • tberends (4)
  • shamshaw (3)
  • jmframe (3)
  • taddyb (2)
  • slama0077 (2)
  • andreucs (2)
  • dankovacek (2)
  • BaptisteFrancois (2)
  • vcloarec (2)
  • KMarkert (2)
Top Labels
Issue Labels
enhancement (2) good first issue (2) documentation (1) bug (1) help wanted (1)
Pull Request Labels
enhancement (2) documentation (1) bug (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 442 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 24
  • Total maintainers: 1
proxy.golang.org: github.com/neuralhydrology/neuralhydrology
  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 4 months ago
pypi.org: neuralhydrology

Library for training deep learning models with environmental focus

  • Versions: 17
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 442 Last month
Rankings
Stargazers count: 4.2%
Forks count: 4.3%
Dependent packages count: 7.3%
Average: 10.2%
Downloads: 13.2%
Dependent repos count: 22.1%
Maintainers (1)
Last synced: 4 months ago

Dependencies

environments/rtd_requirements.txt pypi
  • ipython *
  • nbsphinx >=0.8.0
  • nbsphinx-link >=1.3.0
  • numpy *
  • sphinx >=3.2.1
  • sphinx-rtd-theme >=0.5.0
  • tensorboard *
  • torch *
setup.py pypi
  • matplotlib *
  • numba *
  • numpy *
  • pandas *
  • ruamel.yaml *
  • scipy *
  • tensorboard *
  • torch *
  • tqdm *
  • xarray *
.github/workflows/docs-ci.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/package-install.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/publish-pypi.yml actions
  • actions/checkout master composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish master composite
.github/workflows/pytest-ci.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • s-weigand/setup-conda v1 composite