<div id="top"></div>
<div align=center>
<!-- https://user-images.githubusercontent.com/58784697/200683473-b94e7a80-6f62-405d-8ba9-06ac5620044e.svg -->
# MOGESTpy
<p>
<img src="https://user-images.githubusercontent.com/58784697/210153011-0ccac06f-5ff8-4c80-a2ad-d03528e71e3e.svg"
width = 200/>
</p>
</div>
<details>
<Summary><font size="5">Table of Contents</font></Summary>
- [MOGESTpy](#mogestpy)
- [What is MOGESTpy?](#what-is-mogestpy)
- [Water Resources Management Model](#water-resources-management-model)
- [Models used in MOGESTpy](#models-used-in-mogestpy)
- [Repository Structure](#repository-structure)
- [How to Use MOGESTpy?](#how-to-use-mogestpy)
- [Installing MOGESTpy](#installing-mogestpy)
- [How to Contribute to the Project?](#how-to-contribute-to-the-project)
</details>
<p align="right">(<a href="#top">back to top</a>)</p>
## What is MOGESTpy?
MOGESTpy is an acronym for **Mo**delo de **Gest**ão de Recursos Hídricos (in English: Water Resources Management Model) developed in the [Python3](https://www.python.org/) 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](Quantity/Hydrodynamic/)
- [SMAP](Quantity/Hydrological)
- [0D (Zero Dimensional)](Quality/)
- [BuildUp-Washoff](Quality/)
For more details, check the documentation within the repository.
<p align="right">(<a href="#top">back to top</a>)</p>
## 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
```
<p align="right">(<a href="#top">back to top</a>)</p>
## How to Use MOGESTpy?
### Installing MOGESTpy
Using the following command, you can install MOGESTpy via pip:
```bash
pip install mogestpy
```
Alternatively, you can clone the repository and install the package locally:
```bash
pip install .
```
<p align="right">(<a href="#top">back to top</a>)</p>
## How to Contribute to the Project?
To contribute to the project, simply create an issue. Code additions are welcome; just follow our [contributing document](CONTRIBUTING.md).
<p align="right">(<a href="#top">back to top</a>)</p>
<div align=center>
|Acknowledgments|
|:---:|
||
|[Laboratory of Decision Support Systems](https://sites.usp.br/labsid)|
</div>
<p align="right">(<a href="#top">back to top</a>)</p>
Raw data
{
"_id": null,
"home_page": "https://github.com/dariohhossoda/MOGESTpy",
"name": "MOGESTpy",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "hydrology, water resouces, hydrological model",
"author": "Dario Hachisu Hossoda",
"author_email": "dario.hossoda@usp.br",
"download_url": "https://files.pythonhosted.org/packages/f7/99/8e160fc3448c7f0f08987b81a48108b2c5cc1b40822ebb03926b3a74d530/mogestpy-0.0.3.tar.gz",
"platform": null,
"description": "<div id=\"top\"></div>\n\n<div align=center>\n<!-- https://user-images.githubusercontent.com/58784697/200683473-b94e7a80-6f62-405d-8ba9-06ac5620044e.svg -->\n\n# MOGESTpy\n\n<p>\n <img src=\"https://user-images.githubusercontent.com/58784697/210153011-0ccac06f-5ff8-4c80-a2ad-d03528e71e3e.svg\"\n width = 200/>\n</p>\n</div>\n\n<details>\n<Summary><font size=\"5\">Table of Contents</font></Summary>\n\n- [MOGESTpy](#mogestpy)\n - [What is MOGESTpy?](#what-is-mogestpy)\n - [Water Resources Management Model](#water-resources-management-model)\n - [Models used in MOGESTpy](#models-used-in-mogestpy)\n - [Repository Structure](#repository-structure)\n - [How to Use MOGESTpy?](#how-to-use-mogestpy)\n - [Installing MOGESTpy](#installing-mogestpy)\n - [How to Contribute to the Project?](#how-to-contribute-to-the-project)\n\n</details>\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n## What is MOGESTpy?\n\nMOGESTpy is an acronym for **Mo**delo de **Gest**\u00e3o de Recursos H\u00eddricos (in English: Water Resources Management Model) developed in the [Python3](https://www.python.org/) programming language.\n\n### Water Resources Management Model\n\nA 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.\n\n## Models used in MOGESTpy\n\nThe models used in MOGESTpy include:\n\n- [SIHQUAL](Quantity/Hydrodynamic/)\n- [SMAP](Quantity/Hydrological)\n- [0D (Zero Dimensional)](Quality/)\n- [BuildUp-Washoff](Quality/)\n\nFor more details, check the documentation within the repository.\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n## Repository Structure\n\nThe 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).\n\n```\nMOGESTpy\n\u251c\u2500 Datasets\n\u2502 \u2514\u2500 Results\n\u251c\u2500 Quality\n\u2502 \u251c\u2500 BuWo.py\n\u2502 \u2514\u2500 ZeroD.py\n\u2514\u2500 Quantity\n\u251c\u2500 Hydrological\n\u2502 \u251c\u2500 SMAP.py\n\u2502 \u251c\u2500 Muskingum.py\n\u2502 \u2514\u2500 MassBalance.py\n\u2514\u2500 Hydrodynamic\n\u2514\u2500 SIHQUAL.py\n```\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n## How to Use MOGESTpy?\n\n### Installing MOGESTpy\n\nUsing the following command, you can install MOGESTpy via pip:\n\n```bash\npip install mogestpy\n```\n\nAlternatively, you can clone the repository and install the package locally:\n\n```bash\npip install .\n```\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n## How to Contribute to the Project?\n\nTo contribute to the project, simply create an issue. Code additions are welcome; just follow our [contributing document](CONTRIBUTING.md).\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n<div align=center>\n\n|Acknowledgments|\n|:---:|\n||\n|[Laboratory of Decision Support Systems](https://sites.usp.br/labsid)|\n\n</div>\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Water resources management model based on hydrological and hydronimic models",
"version": "0.0.3",
"project_urls": {
"Bug Tracker": "https://github.com/dariohhossoda/MOGESTpy/issues",
"Homepage": "https://github.com/dariohhossoda/MOGESTpy",
"Repository": "https://github.com/dariohhossoda/MOGESTpy"
},
"split_keywords": [
"hydrology",
" water resouces",
" hydrological model"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bce3c2cc255303c890c8e3da497c39ffbea937d545037d2dae3b7af6625029e9",
"md5": "7d8bdb1dd79ac73387a8ab644c486c01",
"sha256": "8c6cda18b44ef52bb9d74c903a04891173c934f795fbac197f33352785a6d284"
},
"downloads": -1,
"filename": "mogestpy-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7d8bdb1dd79ac73387a8ab644c486c01",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 32412,
"upload_time": "2024-11-27T16:26:49",
"upload_time_iso_8601": "2024-11-27T16:26:49.406766Z",
"url": "https://files.pythonhosted.org/packages/bc/e3/c2cc255303c890c8e3da497c39ffbea937d545037d2dae3b7af6625029e9/mogestpy-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f7998e160fc3448c7f0f08987b81a48108b2c5cc1b40822ebb03926b3a74d530",
"md5": "5d80f7c637442e4a12d6b29cb374c957",
"sha256": "4011766fabee474b905c5f951f0389376a298aaec181a8e8c43566f95fd3d162"
},
"downloads": -1,
"filename": "mogestpy-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "5d80f7c637442e4a12d6b29cb374c957",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 29604,
"upload_time": "2024-11-27T16:26:51",
"upload_time_iso_8601": "2024-11-27T16:26:51.346750Z",
"url": "https://files.pythonhosted.org/packages/f7/99/8e160fc3448c7f0f08987b81a48108b2c5cc1b40822ebb03926b3a74d530/mogestpy-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-27 16:26:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dariohhossoda",
"github_project": "MOGESTpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mogestpy"
}
JSON
