Awesome

About The Project

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.

Main features

The model was developed based on classical concepts of hydrological processes and equations based mainly on SPHY ³, WEAP ⁴, and WetSpass-M ⁵. 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

1. Download the latest release zip file from the releases page;
2. 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

• Laboratório de Sistemas de Suporte a Decisões Aplicados à Engenharia Ambiental e de Recursos Hídricos
• Departamento de Engenharia Hidráulica e Ambiental da Escola Politécnica da Universidade de São Paulo
• Fundo Patrimonial Amigos da Poli