rubem

The Rainfall rUnoff Balance Enhanced Model (RUBEM) distributed hydrological model

https://github.com/labsid-usp/rubem

Science Score: 67.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 13 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.5%) to scientific vocabulary

Keywords

catchment grid hydrological-model hydrology pcraster remote-sensing rubem simulation-model water

Keywords from Contributors

interactive mesh interpretability profiles distribution sequences generic projection standardization optim

Last synced: 6 months ago · JSON representation ·

Repository

The Rainfall rUnoff Balance Enhanced Model (RUBEM) distributed hydrological model

Basic Info

Host: GitHub
Owner: LabSid-USP
License: gpl-3.0
Language: Python
Default Branch: main
Homepage: https://labsid.poli.usp.br/softwares/rubem-hydrological/
Size: 4.2 MB

Statistics

Stars: 8
Watchers: 3
Forks: 1
Open Issues: 0
Releases: 5

Topics

catchment grid hydrological-model hydrology pcraster remote-sensing rubem simulation-model water

Created about 5 years ago · Last pushed 6 months ago

Metadata Files

Readme Contributing License Code of conduct Citation

RUBEM
Rainfall rUnoff Balance Enhanced Model

RUBEM is a distributed hydrological model to calculate monthly flows with changes in land use over time.
Explore the docs »

Support Form · Report Bug · Request Feature

About The Project

The Rainfall rUnoff Balance Enhanced Model (RUBEM) [^MELLOetal2022a][^MELLOetal2022b] is a hydrological model for transforming precipitation into surface and subsurface runoff. The model is based on equations that represent the physical processes of the hydrological cycle, with spatial distribution defined by pixel, in distinct vegetated and non-vegetated covers, and has the flexibility to study a wide range of applications, including impacts of changes in climate and land use, has flexible spatial resolution, the inputs are raster-type matrix files obtained from remote sensing data and operates with a reduced number of parameters arranged in a configuration file that facilitates its modification throughout the area.

Main features

The model was developed based on classical concepts of hydrological processes and equations based mainly on SPHY [^TERINKetal2015], WEAP [^YATESetal2005], and WetSpass-M [^ABDOLLAHIetal2017]. The main features of the developed model are:

Distributed monthly step model;
Hydrological process based on soil water balance in each pixel, and flow total calculated after composition of the resulting accumulated flow, according to Direction drainage network flow established by the digital elevation model (DEM);
Calculations for two zones: rootzone and saturated;
Evapotranspiration and interception process based on vegetation index: Leaf Area Index (LAI), Photosynthetically Active Radiation Fraction (FPAR) and Normalized Difference Vegetation Index (NDVI); and
Sub-pixel level coverage classification, represented by four fractions that represent percentage of total pixel area covered exclusively by: area vegetated, bare soil area, water area and impervious area.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

From Miniconda base envionment create a new conda envionment

sh conda env create -n rubem --file env-prod.yml

Activate the new environment
- Windows
powershell conda activate rubem - Linux, macOS

sh source activate rubem

Installation

Download the latest release zip file from the releases page;
Extract the zip, and copy the extracted root directory into a local directory.

Usage

Typical usage example

sh python rubem --configfile config.ini

Help usage example

sh python rubem -h

For more examples, please refer to the user guide and tutorials.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. See CONTRIBUTING.md for more information.

License

Distributed under the GPLv3 License. See LICENSE.md for more information.

Contact

[!TIP] In any of our communication channels please abide by the Code of Conduct. In summary, being friendly and patient, considerate, respectful, and careful in your choice of words.

Contact us at: rubem.hydrological@labsid.eng.br
FAQ: https://rubem.readthedocs.io/en/latest/faq.html
Support Form: https://forms.gle/JmxWKoXh4C29V2rD8
Project Link: https://github.com/LabSid-USP/RUBEM

Acknowledgements

[^ABDOLLAHIetal2017]: Abdollahi, K., Bashir, I., Harouna, M., Griensven, A., Huysmans, M., Batelaan, O., Verbeiren, B., A distributed monthly water balance model: formulation and application on Black Volta Basin, Environ Earth Sci, 76:198, 2017. https://doi.org/10.1007/s12665-017-6512-1 [^MELLOetal2022a]: Méllo Júnior, A.V.; Olivos, L.M.O.; Billerbeck, C.; Marcellini, S.S.; Vichete, W.D.; Pasetti, D.M.; da Silva, L.M.; Soares, G.A.d.S.; Tercini, J.R.B. Rainfall Runoff Balance Enhanced Model Applied to Tropical Hydrology. Water 2022, 14, 1958. https://doi.org/10.3390/w14121958 [^MELLOetal2022b]: Méllo Júnior, A.V.; Olivos, L.M.O.; Billerbeck, C.; Marcellini, S.S.; Vichete, W.D.; Pasetti, D.M.; da Silva, L.M.; Soares, G.A.d.S.; Tercini, J.R.B. Rainfall-Runoff Balance Enhanced Model Applied to Tropical Hydrology - Supplementary Document. Zenodo 2022. https://doi.org/10.5281/zenodo.6614981 [^TERINKetal2015]: Terink, W., Lutz, A. F., Simons, G. W. H., Immerzeel, W. W., & Droogers, P. SPHY v2.0: Spatial Processes in HYdrology. Geoscientific Model Development 2015, 8(7), 2009–2034. https://doi.org/10.5194/gmd-8-2009-2015 [^YATESetal2005]: Yates, D., Sieber, J., Purkey, D., & Huber-Lee, A. WEAP21—A Demand-, Priority-, and Preference-Driven Water Planning Model. Water International 2005, 30(4), 487–500. https://doi.org/10.1080/02508060508691893

Owner

Name: LabSid
Login: LabSid-USP
Kind: organization
Location: São Paulo, Brazil

Website: www.labsid.eng.br
Repositories: 3
Profile: https://github.com/LabSid-USP

Laboratório de Sistemas de Suporte a Decisões em Engenharia Ambiental e Recursos Hídricos

Citation (CITATION.cff)

cff-version: 1.2.0
title: Rainfall rUnoff Balance Enhanced Model (RUBEM)
message: >-
  If you use this software, please cite it using the metadata from this file.
type: software
authors:
- given-names: Arisvaldo
  name-suffix: Jr
  family-names: 'Vieira Méllo'
  email: arisvaldo@usp.br
  orcid: 'https://orcid.org/0000-0001-7110-3128'
  affiliation: 'Universidade de São Paulo, São Paulo, Brasil'
- given-names: Lina Maria
  family-names: Osorio Olivos
  email: lmosorioo@alumni.usp.br
  affiliation: 'Universidade de São Paulo, São Paulo, Brasil'
  orcid: 'https://orcid.org/0000-0001-7180-6544'
- given-names: Camila
  family-names: Billerbeck
  email: camila.billerbeck@alumni.usp.br
  affiliation: 'Universidade de São Paulo, São Paulo, Brasil'
  orcid: 'https://orcid.org/0000-0001-5727-2128'
- given-names: Silvana
  family-names: Susko Marcellini
  email: silvana@labsid.eng.br
  affiliation: >-
    Laboratório de Sistemas de Suporte a Decisões Aplicados à Engenharia Ambiental e de Recursos Hídricos (LabSid), Escola Politécnica, Universidade de São Paulo, São Paulo, Brasil
  orcid: 'https://orcid.org/0000-0002-3940-8287'
- given-names: William
  family-names: Dantas Vichete
  email: williamvichete@alumni.usp.br
  affiliation: 'Universidade de São Paulo, São Paulo, Brasil'
  orcid: 'https://orcid.org/0000-0003-1225-1037'
- given-names: Daniel
  family-names: Manabe Pasetti
  email: daniel.pasetti@alumni.usp.br
  affiliation: 'Universidade de São Paulo, São Paulo, Brasil'
- given-names: Lígia
  family-names: Monteiro da Silva
  email: ligia@labsid.eng.br
  affiliation: >-
    Laboratório de Sistemas de Suporte a Decisões Aplicados à Engenharia Ambiental e de Recursos Hídricos (LabSid), Escola Politécnica, Universidade de São Paulo, São Paulo, Brasil
  orcid: 'https://orcid.org/0000-0002-3033-2140'
- given-names: Gabriel Anísio
  family-names: Santos Soares
  name-particle: dos
  orcid: 'https://orcid.org/0000-0002-3231-0455'
  email: gabriel@labsid.eng.br
  affiliation: >-
    Laboratório de Sistemas de Suporte a Decisões Aplicados à Engenharia Ambiental e de Recursos Hídricos (LabSid), Escola Politécnica, Universidade de São Paulo, São Paulo, Brasil #magic___^_^___line
- given-names: João Rafael
  family-names: Bergamaschi Tercini
  email: tercini@alumni.usp.br
  affiliation: 'Universidade de São Paulo, São Paulo, Brasil'
  orcid: 'https://orcid.org/0000-0002-6070-1090'
identifiers:
- type: doi
  value: 10.5281/zenodo.10562516
repository-code: 'https://github.com/LabSid-USP/rubem'
abstract: >-
  The Rainfall rUnoff Balance Enhanced Model (RUBEM) is a hydrological model for transforming precipitation into surface and subsurface runoff. The model is based on equations that represent the physical processes of the hydrological cycle, with spatial distribution defined by pixel, in distinct vegetated and non-vegetated covers, and has the flexibility to study a wide range of applications, including impacts of changes in climate and land use, has flexible spatial resolution, the inputs are raster-type matrix files obtained from remote sensing data and operates with a reduced number of parameters arranged in a configuration file that facilitates its modification throughout the area.
keywords:
- hydrological modelling
- distributed model
- land use and land cover
- water balance
- remote sensing
- PCRaster
license: GPL-3.0
preferred-citation:
  type: article
  authors:
  - given-names: Arisvaldo
    name-suffix: Jr
    family-names: 'Vieira Méllo'
    email: arisvaldo@usp.br
    orcid: 'https://orcid.org/0000-0001-7110-3128'
    affiliation: 'Universidade de São Paulo, São Paulo, Brasil'
  - given-names: Lina Maria
    family-names: Osorio Olivos
    email: lmosorioo@alumni.usp.br
    affiliation: 'Universidade de São Paulo, São Paulo, Brasil'
    orcid: 'https://orcid.org/0000-0001-7180-6544'
  - given-names: Camila
    family-names: Billerbeck
    email: camila.billerbeck@alumni.usp.br
    affiliation: 'Universidade de São Paulo, São Paulo, Brasil'
    orcid: 'https://orcid.org/0000-0001-5727-2128'
  - given-names: Silvana
    family-names: Susko Marcellini
    email: silvana@labsid.eng.br
    affiliation: >-
      Laboratório de Sistemas de Suporte a Decisões Aplicados à Engenharia Ambiental e de Recursos Hídricos (LabSid), Escola Politécnica, Universidade de São Paulo, São Paulo, Brasil
    orcid: 'https://orcid.org/0000-0002-3940-8287'
  - given-names: William
    family-names: Dantas Vichete
    email: williamvichete@alumni.usp.br
    affiliation: 'Universidade de São Paulo, São Paulo, Brasil'
    orcid: 'https://orcid.org/0000-0003-1225-1037'
  - given-names: Daniel
    family-names: Manabe Pasetti
    email: daniel.pasetti@alumni.usp.br
    affiliation: 'Universidade de São Paulo, São Paulo, Brasil'
  - given-names: Lígia
    family-names: Monteiro da Silva
    email: ligia@labsid.eng.br
    affiliation: >-
      Laboratório de Sistemas de Suporte a Decisões Aplicados à Engenharia Ambiental e de Recursos Hídricos (LabSid), Escola Politécnica, Universidade de São Paulo, São Paulo, Brasil
    orcid: 'https://orcid.org/0000-0002-3033-2140'
  - given-names: Gabriel Anísio
    family-names: Santos Soares
    name-particle: dos
    orcid: 'https://orcid.org/0000-0002-3231-0455'
    email: gabriel@labsid.eng.br
    affiliation: >-
      Laboratório de Sistemas de Suporte a Decisões Aplicados à Engenharia Ambiental e de Recursos Hídricos (LabSid), Escola Politécnica, Universidade de São Paulo, São Paulo, Brasil #magic___^_^___line
  - given-names: João Rafael
    family-names: Bergamaschi Tercini
    email: tercini@alumni.usp.br
    affiliation: 'Universidade de São Paulo, São Paulo, Brasil'
    orcid: 'https://orcid.org/0000-0002-6070-1090'
  doi: "10.3390/w14121958"
  journal: "Water"
  title: "Rainfall Runoff Balance Enhanced Model Applied to Tropical Hydrology"
  start: 1958
  issue: 12
  volume: 14
  year: 2022

GitHub Events

Total

Watch event: 1
Delete event: 6
Issue comment event: 6
Push event: 5
Pull request review event: 2
Pull request event: 8
Create event: 2

Last Year

Watch event: 1
Delete event: 6
Issue comment event: 6
Push event: 5
Pull request review event: 2
Pull request event: 8
Create event: 2

Committers

Last synced: 7 months ago

All Time

Total Commits: 525
Total Committers: 4
Avg Commits per committer: 131.25
Development Distribution Score (DDS): 0.09

Past Year

Commits: 2
Committers: 1
Avg Commits per committer: 2.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Gabriel Soares	7****l	478
Lina Osorio	l**o@u**r	34
dependabot[bot]	4****]	9
dmpasetti	4****i	4

Committer Domains (Top 20 + Academic)

usp.br: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 86
Total pull requests: 145
Average time to close issues: about 1 month
Average time to close pull requests: 6 days
Total issue authors: 4
Total pull request authors: 4
Average comments per issue: 0.65
Average comments per pull request: 0.2
Merged pull requests: 137
Bot issues: 0
Bot pull requests: 21

Past Year

Issues: 0
Pull requests: 9
Average time to close issues: N/A
Average time to close pull requests: about 2 months
Issue authors: 0
Pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 0.89
Merged pull requests: 7
Bot issues: 0
Bot pull requests: 9

View more stats

Top Authors

Issue Authors

soaressgabriel (78)
LINAMARIAOSORIO (5)
wdvichete84 (2)
camilabillerbeck (1)

Pull Request Authors

soaressgabriel (119)
dependabot[bot] (21)
LINAMARIAOSORIO (4)
wdvichete84 (1)

Top Labels

Issue Labels

enhancement (64) documentation (18) bug (14) high (14) stale (12) help wanted (8) question (4) test (2) low (1)

Pull Request Labels

enhancement (25) documentation (12) bug (7) help wanted (6) high (3) stale (1)

Packages

Total packages: 2
Total downloads: unknown

Total dependent packages: 0
(may contain duplicates)
Total dependent repositories: 0
(may contain duplicates)
Total versions: 10

proxy.golang.org: github.com/labsid-usp/rubem

Documentation: https://pkg.go.dev/github.com/labsid-usp/rubem#section-documentation
License: gpl-3.0
Latest release: v0.1.3
published almost 4 years ago

Versions: 5
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

proxy.golang.org: github.com/LabSid-USP/RUBEM

Documentation: https://pkg.go.dev/github.com/LabSid-USP/RUBEM#section-documentation
License: gpl-3.0
Latest release: v0.1.3
published almost 4 years ago

Versions: 5
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

doc/requirements.txt pypi

Sphinx ==4.2.0
sphinx-autodoc-typehints ==1.12.0
sphinx-rtd-theme ==1.0.0
sphinxcontrib-email ==0.3.5
sphinxcontrib-youtube ==1.0.1

.github/workflows/build-test-conda.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite

.github/workflows/codecov-conda.yml actions

actions/checkout master composite
actions/setup-python master composite
codecov/codecov-action v2 composite

.github/workflows/codeql-analysis.yml actions

actions/checkout v2 composite
github/codeql-action/analyze v1 composite
github/codeql-action/autobuild v1 composite
github/codeql-action/init v1 composite

.github/workflows/greetings.yml actions

actions/first-interaction v1 composite

.github/workflows/stale.yml actions

actions/stale v3 composite

.github/workflows/build-release.yml actions

actions/checkout v2 composite
conda-incubator/setup-miniconda v2 composite
softprops/action-gh-release v1 composite

rubem

Science Score: 67.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

RUBEMRainfall rUnoff Balance Enhanced Model

About The Project

Main features

Getting Started

Prerequisites

Installation

Usage

Roadmap

Contributing

License

Contact

Acknowledgements

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

proxy.golang.org: github.com/labsid-usp/rubem

Rankings

proxy.golang.org: github.com/LabSid-USP/RUBEM

Rankings

Dependencies

RUBEM
Rainfall rUnoff Balance Enhanced Model