RUBEM

A distributed hydrological model to calculate monthly flows with changes in land use over time.
https://github.com/LabSid-USP/RUBEM

Category: Hydrosphere
Sub Category: Freshwater and Hydrology

Keywords

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

Keywords from Contributors

optimize archiving measur transforms generic compose observation conversion animals projection

Last synced: about 23 hours ago
JSON representation

Repository metadata

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

Host: GitHub
URL: https://github.com/LabSid-USP/RUBEM
Owner: LabSid-USP
License: gpl-3.0
Created: 2021-01-28T19:58:34.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2026-09-24T20:45:49.000Z (7 days ago)
Last Synced: 2026-09-25T19:26:26.864Z (6 days ago)
Topics: catchment, grid, hydrological-model, hydrology, pcraster, remote-sensing, rubem, simulation-model, water
Language: Python
Homepage: https://labsid.poli.usp.br/softwares/rubem-hydrological/
Size: 9.37 MB
Stars: 9
Watchers: 2
Forks: 1
Open Issues: 11
Releases: 5
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: SUPPORT.md

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
```
conda env create -n rubem --file env-prod.yml
```
Activate the new environment
- Windows
```
conda activate rubem
```
- Linux, macOS
```
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

  python rubem --configfile config.ini

Help usage example

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

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

Owner metadata

Name: LabSid
Login: LabSid-USP
Email:
Kind: organization
Description: Laboratório de Sistemas de Suporte a Decisões em Engenharia Ambiental e Recursos Hídricos
Website: www.labsid.eng.br
Location: São Paulo, Brazil
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/70539830?v=4
Repositories: 3
Last ynced at: 2026-09-29T19:44:43.443Z
Profile URL: https://github.com/LabSid-USP

GitHub Events

Total

Create event: 11
Delete event: 13
Issue comment event: 19
Issues event: 13
Pull request event: 13
Pull request review comment event: 1
Pull request review event: 6
Push event: 19
Watch event: 1

Last Year

Create event: 9
Delete event: 7
Issue comment event: 13
Issues event: 13
Pull request event: 5
Pull request review comment event: 1
Pull request review event: 4
Push event: 14

Committers metadata

Last synced: 2 days ago

Total Commits: 807
Total Committers: 5
Avg Commits per committer: 161.4
Development Distribution Score (DDS): 0.088

Commits in past year: 278
Committers in past year: 4
Avg Commits per committer in past year: 69.5
Development Distribution Score (DDS) in past year: 0.072

Name	Email	Commits
Gabriel Soares	7****l	736
Lina Osorio	l**o@u**r	39
dependabot[bot]	4****]	25
dmpasetti	4****i	4
camila billerbeck	5****k	3

Committer domains:

usp.br: 1

Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 158
Total pull requests: 213
Average time to close issues: about 2 months
Average time to close pull requests: 8 days
Total issue authors: 4
Total pull request authors: 4
Average comments per issue: 0.49
Average comments per pull request: 0.55
Merged pull request: 173
Bot issues: 0
Bot pull requests: 41

Past year issues: 72
Past year pull requests: 68
Past year average time to close issues: 1 day
Past year average time to close pull requests: 14 days
Past year issue authors: 2
Past year pull request authors: 3
Past year average comments per issue: 0.11
Past year average comments per pull request: 1.31
Past year merged pull request: 36
Past year bot issues: 0
Past year bot pull requests: 20

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/LabSid-USP/RUBEM

Top Issue Authors

soaressgabriel (146)
LINAMARIAOSORIO (9)
wdvichete84 (2)
camilabillerbeck (1)

Top Pull Request Authors

soaressgabriel (163)
dependabot[bot] (41)
LINAMARIAOSORIO (8)
wdvichete84 (1)

Top Issue Labels

enhancement (106)
bug (36)
documentation (21)
high (14)
test (8)
help wanted (8)
roadmap (7)
stale (6)
question (4)
paper (2)
low (2)
medium (1)

Top Pull Request Labels

enhancement (25)
documentation (12)
stale (8)
bug (7)
dependencies (6)
help wanted (6)
github_actions (4)
high (3)
python (1)
conda (1)

Package metadata

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

Homepage:
Documentation: https://pkg.go.dev/github.com/labsid-usp/rubem#section-documentation
Licenses: gpl-3.0
Latest release: v0.1.3 (published over 4 years ago)
Last Synced: 2026-09-29T17:31:58.066Z (2 days ago)
Versions: 5
Dependent Packages: 0
Dependent Repositories: 0
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%

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

Homepage:
Documentation: https://pkg.go.dev/github.com/LabSid-USP/RUBEM#section-documentation
Licenses: gpl-3.0
Latest release: v0.1.3 (published over 4 years ago)
Last Synced: 2026-09-29T17:31:58.112Z (2 days ago)
Versions: 5
Dependent Packages: 0
Dependent Repositories: 0
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%

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/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

environment.yml conda

gdal 3.*
humanize >=4.16.0
numpy 2.*
pcraster 4.4.*
pip
pydantic >=2.11,<3
python >=3.12
python-dateutil >=2.9.0
typer >=0.16,<1

.github/workflows/release.yml actions

actions/attest-build-provenance 4d101475d8b20a2381f78447822ac1eab6504dd8 composite
actions/checkout 3d3c42e5aac5ba805825da76410c181273ba90b1 composite
actions/download-artifact 3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c composite
actions/setup-python 5fda3b95a4ea91299a34e894583c3862153e4b97 composite
sigstore/gh-action-sigstore-python 790bc6befb9d733738f18d8f895854b453640ec9 composite
softprops/action-gh-release 3d0d9888cb7fd7b750713d6e236d1fcb99157228 composite

.github/workflows/scorecard.yml actions

actions/checkout 3d3c42e5aac5ba805825da76410c181273ba90b1 composite
github/codeql-action/upload-sarif cdf488f595d80d6e07e03d4674febd5ab45fa938 composite
ossf/scorecard-action 2d1146689b8cda280b9bc96326124645441f03bc composite

.github/workflows/ci.yml actions

actions/checkout 3d3c42e5aac5ba805825da76410c181273ba90b1 composite
actions/setup-python 5fda3b95a4ea91299a34e894583c3862153e4b97 composite
actions/upload-artifact 043fb46d1a93c77aae656e7c1c64a875d1fc6a0a composite
codecov/codecov-action fb8b3582c8e4def4969c97caa2f19720cb33a72f composite
mamba-org/setup-micromamba f457c30a868e4760d3a6fcea5f25dc655b8edf39 composite

pyproject.toml pypi

humanize >=4
numpy >=2
pydantic >=2.11,<3
python-dateutil >=2
typer >=0.16,<1

Score: -Infinity

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology