mogestpy 1.0.0

Water resources management model based on hydrological and hydronimic models

MOGESTpy

Table of Contents

• MOGESTpy
  • What is MOGESTpy?
    • Water Resources Management Model
  • Models used in MOGESTpy
  • Repository Structure
  • How to Use MOGESTpy?
    • Installing MOGESTpy
  • How to Contribute to the Project?

(back to top)

What is MOGESTpy?

MOGESTpy is an acronym for Modelo de Gestão de Recursos Hídricos (in English: Water Resources Management Model) developed in the Python3 programming language.

Water Resources Management Model

A management model uses water quantity and quality modeling tools to assist in decision-making. This modeling is done through simulation models where natural processes are represented from precipitation in the watershed area to its transport in rivers and channels to the watershed's outlet.

Models used in MOGESTpy

The models used in MOGESTpy include:

• SIHQUAL
• SMAP
• 0D (Zero Dimensional)
• BuildUp-Washoff

For more details, check the documentation within the repository.

(back to top)

Repository Structure

The repository is divided into three main parts: quality models (Quality), quantitative models (Quantity), and simulation data for testing and examples of how each module works (Datasets).

MOGESTpy
├─ Datasets
│ └─ Results
├─ Quality
│ ├─ BuWo.py
│ └─ ZeroD.py
└─ Quantity
├─ Hydrological
│ ├─ SMAP.py
│ ├─ Muskingum.py
│ └─ MassBalance.py
└─ Hydrodynamic
└─ SIHQUAL.py

(back to top)

How to Use MOGESTpy?

Installing MOGESTpy

Using the following command, you can install MOGESTpy via pip:

pip install mogestpy

Alternatively, you can clone the repository and install the package locally:

pip install .

(back to top)

How to Contribute to the Project?

To contribute to the project, simply create an issue. Code additions are welcome; just follow our contributing document.

(back to top)

Acknowledgments
Laboratory of Decision Support Systems

(back to top)