DOIGPL-3.0-or-later LicenseUnit testsCodeQLDocumentation StatusIssuesContributorsGitHub Commit ActivityForksStargazersLabSid YouTube Channel


Logo

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) 12 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 3, WEAP 4, and WetSpass-M 5. 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

RUBEM depends on PCRaster and GDAL, which are distributed through conda-forge. You need:

  • Python 3.12 or later
  • A conda-compatible package manager (Miniconda, Miniforge or micromamba)

Installation

  1. Get the source code, either by cloning the repository:

    git clone https://github.com/LabSid-USP/RUBEM.git
    cd RUBEM

    or by downloading the archive of the latest release from the releases page and entering the extracted directory, which is named after the release:

    tar -xzf RUBEM-<version>.tar.gz
    cd RUBEM-<version>
  2. Create and activate the runtime environment, with conda:

    conda env create -f environment.yml
    conda activate rubem

    or with micromamba, which has no conda command:

    micromamba create -f environment.yml -y
    micromamba activate rubem
  3. Install RUBEM into the environment:

    pip install .

Usage

  • Typical usage example

    rubem run --configfile config.json
  • Help usage example

    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 GNU General Public License, version 3 or (at your option) any later version (SPDX: GPL-3.0-or-later). See LICENSE 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.

Acknowledgements

Footnotes

  1. 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

  2. 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

  3. 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

  4. 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

  5. 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

About

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

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

9 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

DOIGPL-3.0-or-later LicenseUnit testsCodeQLDocumentation StatusIssuesContributorsGitHub Commit ActivityForksStargazersLabSid YouTube Channel


Logo

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) 12 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 3, WEAP 4, and WetSpass-M 5. 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

RUBEM depends on PCRaster and GDAL, which are distributed through conda-forge. You need:

  • Python 3.12 or later
  • A conda-compatible package manager (Miniconda, Miniforge or micromamba)

Installation

  1. Get the source code, either by cloning the repository:

    git clone https://github.com/LabSid-USP/RUBEM.git
    cd RUBEM

    or by downloading the archive of the latest release from the releases page and entering the extracted directory, which is named after the release:

    tar -xzf RUBEM-<version>.tar.gz
    cd RUBEM-<version>
  2. Create and activate the runtime environment, with conda:

    conda env create -f environment.yml
    conda activate rubem

    or with micromamba, which has no conda command:

    micromamba create -f environment.yml -y
    micromamba activate rubem
  3. Install RUBEM into the environment:

    pip install .

Usage

  • Typical usage example

    rubem run --configfile config.json
  • Help usage example

    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 GNU General Public License, version 3 or (at your option) any later version (SPDX: GPL-3.0-or-later). See LICENSE 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.

Acknowledgements

Footnotes

  1. 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

  2. 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

  3. 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

  4. 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

  5. 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

About

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

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

9 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

DOIGPL-3.0-or-later LicenseUnit testsCodeQLDocumentation StatusIssuesContributorsGitHub Commit ActivityForksStargazersLabSid YouTube Channel


Logo

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) 12 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 3, WEAP 4, and WetSpass-M 5. 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

RUBEM depends on PCRaster and GDAL, which are distributed through conda-forge. You need:

  • Python 3.12 or later
  • A conda-compatible package manager (Miniconda, Miniforge or micromamba)

Installation

  1. Get the source code, either by cloning the repository:

    git clone https://github.com/LabSid-USP/RUBEM.git
    cd RUBEM

    or by downloading the archive of the latest release from the releases page and entering the extracted directory, which is named after the release:

    tar -xzf RUBEM-<version>.tar.gz
    cd RUBEM-<version>
  2. Create and activate the runtime environment, with conda:

    conda env create -f environment.yml
    conda activate rubem

    or with micromamba, which has no conda command:

    micromamba create -f environment.yml -y
    micromamba activate rubem
  3. Install RUBEM into the environment:

    pip install .

Usage

  • Typical usage example

    rubem run --configfile config.json
  • Help usage example

    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 GNU General Public License, version 3 or (at your option) any later version (SPDX: GPL-3.0-or-later). See LICENSE 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.

Acknowledgements

Footnotes

  1. 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

  2. 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

  3. 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

  4. 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

  5. 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

About

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

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

9 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

DOIGPL-3.0-or-later LicenseUnit testsCodeQLDocumentation StatusIssuesContributorsGitHub Commit ActivityForksStargazersLabSid YouTube Channel


Logo

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) 12 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 3, WEAP 4, and WetSpass-M 5. 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

RUBEM depends on PCRaster and GDAL, which are distributed through conda-forge. You need:

  • Python 3.12 or later
  • A conda-compatible package manager (Miniconda, Miniforge or micromamba)

Installation

  1. Get the source code, either by cloning the repository:

    git clone https://github.com/LabSid-USP/RUBEM.git
    cd RUBEM

    or by downloading the archive of the latest release from the releases page and entering the extracted directory, which is named after the release:

    tar -xzf RUBEM-<version>.tar.gz
    cd RUBEM-<version>
  2. Create and activate the runtime environment, with conda:

    conda env create -f environment.yml
    conda activate rubem

    or with micromamba, which has no conda command:

    micromamba create -f environment.yml -y
    micromamba activate rubem
  3. Install RUBEM into the environment:

    pip install .

Usage

  • Typical usage example

    rubem run --configfile config.json
  • Help usage example

    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 GNU General Public License, version 3 or (at your option) any later version (SPDX: GPL-3.0-or-later). See LICENSE 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.

Acknowledgements

Footnotes

  1. 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

  2. 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

  3. 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

  4. 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

  5. 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

About

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

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

9 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

DOIGPL-3.0-or-later LicenseUnit testsCodeQLDocumentation StatusIssuesContributorsGitHub Commit ActivityForksStargazersLabSid YouTube Channel


Logo

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) 12 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 3, WEAP 4, and WetSpass-M 5. 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

RUBEM depends on PCRaster and GDAL, which are distributed through conda-forge. You need:

  • Python 3.12 or later
  • A conda-compatible package manager (Miniconda, Miniforge or micromamba)

Installation

  1. Get the source code, either by cloning the repository:

    git clone https://github.com/LabSid-USP/RUBEM.git
    cd RUBEM

    or by downloading the archive of the latest release from the releases page and entering the extracted directory, which is named after the release:

    tar -xzf RUBEM-<version>.tar.gz
    cd RUBEM-<version>
  2. Create and activate the runtime environment, with conda:

    conda env create -f environment.yml
    conda activate rubem

    or with micromamba, which has no conda command:

    micromamba create -f environment.yml -y
    micromamba activate rubem
  3. Install RUBEM into the environment:

    pip install .

Usage

  • Typical usage example

    rubem run --configfile config.json
  • Help usage example

    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 GNU General Public License, version 3 or (at your option) any later version (SPDX: GPL-3.0-or-later). See LICENSE 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.

Acknowledgements

Footnotes

  1. 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

  2. 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

  3. 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

  4. 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

  5. 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

About

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

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

9 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

DOIGPL-3.0-or-later LicenseUnit testsCodeQLDocumentation StatusIssuesContributorsGitHub Commit ActivityForksStargazersLabSid YouTube Channel


Logo

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) 12 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 3, WEAP 4, and WetSpass-M 5. 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

RUBEM depends on PCRaster and GDAL, which are distributed through conda-forge. You need:

  • Python 3.12 or later
  • A conda-compatible package manager (Miniconda, Miniforge or micromamba)

Installation

  1. Get the source code, either by cloning the repository:

    git clone https://github.com/LabSid-USP/RUBEM.git
    cd RUBEM

    or by downloading the archive of the latest release from the releases page and entering the extracted directory, which is named after the release:

    tar -xzf RUBEM-<version>.tar.gz
    cd RUBEM-<version>
  2. Create and activate the runtime environment, with conda:

    conda env create -f environment.yml
    conda activate rubem

    or with micromamba, which has no conda command:

    micromamba create -f environment.yml -y
    micromamba activate rubem
  3. Install RUBEM into the environment:

    pip install .

Usage

  • Typical usage example

    rubem run --configfile config.json
  • Help usage example

    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 GNU General Public License, version 3 or (at your option) any later version (SPDX: GPL-3.0-or-later). See LICENSE 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.

Acknowledgements

Footnotes

  1. 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

  2. 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

  3. 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

  4. 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

  5. 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

About

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

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

9 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

DOIGPL-3.0-or-later LicenseUnit testsCodeQLDocumentation StatusIssuesContributorsGitHub Commit ActivityForksStargazersLabSid YouTube Channel


Logo

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) 12 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 3, WEAP 4, and WetSpass-M 5. 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

RUBEM depends on PCRaster and GDAL, which are distributed through conda-forge. You need:

  • Python 3.12 or later
  • A conda-compatible package manager (Miniconda, Miniforge or micromamba)

Installation

  1. Get the source code, either by cloning the repository:

    git clone https://github.com/LabSid-USP/RUBEM.git
    cd RUBEM

    or by downloading the archive of the latest release from the releases page and entering the extracted directory, which is named after the release:

    tar -xzf RUBEM-<version>.tar.gz
    cd RUBEM-<version>
  2. Create and activate the runtime environment, with conda:

    conda env create -f environment.yml
    conda activate rubem

    or with micromamba, which has no conda command:

    micromamba create -f environment.yml -y
    micromamba activate rubem
  3. Install RUBEM into the environment:

    pip install .

Usage

  • Typical usage example

    rubem run --configfile config.json
  • Help usage example

    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 GNU General Public License, version 3 or (at your option) any later version (SPDX: GPL-3.0-or-later). See LICENSE 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.

Acknowledgements

Footnotes

  1. 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

  2. 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

  3. 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

  4. 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

  5. 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

About

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

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

9 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

DOIGPL-3.0-or-later LicenseUnit testsCodeQLDocumentation StatusIssuesContributorsGitHub Commit ActivityForksStargazersLabSid YouTube Channel


Logo

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) 12 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 3, WEAP 4, and WetSpass-M 5. 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

RUBEM depends on PCRaster and GDAL, which are distributed through conda-forge. You need:

  • Python 3.12 or later
  • A conda-compatible package manager (Miniconda, Miniforge or micromamba)

Installation

  1. Get the source code, either by cloning the repository:

    git clone https://github.com/LabSid-USP/RUBEM.git
    cd RUBEM

    or by downloading the archive of the latest release from the releases page and entering the extracted directory, which is named after the release:

    tar -xzf RUBEM-<version>.tar.gz
    cd RUBEM-<version>
  2. Create and activate the runtime environment, with conda:

    conda env create -f environment.yml
    conda activate rubem

    or with micromamba, which has no conda command:

    micromamba create -f environment.yml -y
    micromamba activate rubem
  3. Install RUBEM into the environment:

    pip install .

Usage

  • Typical usage example

    rubem run --configfile config.json
  • Help usage example

    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 GNU General Public License, version 3 or (at your option) any later version (SPDX: GPL-3.0-or-later). See LICENSE 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.

Acknowledgements

Footnotes

  1. 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

  2. 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

  3. 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

  4. 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

  5. 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

About

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

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

9 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages