# PymHM - Python Mesoscale Hydrological Model
[](https://www.python.org/downloads/)
[](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
[](https://badge.fury.io/py/pymhm)
A Python package for mesoscale hydrological modeling, designed to work both as a standalone library and as a QGIS plugin.
## Features
- **Hydrological Modeling**: Core functionality for mesoscale hydrological processes
- **QGIS Integration**: Seamless integration with QGIS 3.0+ as a plugin
- **Data Processing**: Tools for handling hydrological data and model inputs
- **Visualization**: Built-in plotting and visualization capabilities
- **Extensible**: Modular design for easy extension and customization
## Installation
### From PyPI (Recommended)
```bash
pip install pymhm
```
### From Source
```bash
git clone https://github.com/SanjeevBashyal/pymhm.git
cd pymhm
pip install -e .
```
### For QGIS Plugin
1. Download the plugin from the QGIS Plugin Manager
2. Or install manually by copying the `pymhm` folder to your QGIS plugins directory
## Quick Start
### As a Python Package
```python
import pymhm
# Initialize the model
model = pymhm.HydrologicalModel()
# Run simulation
results = model.run_simulation()
```
### As a QGIS Plugin
1. Open QGIS
2. Go to Plugins → Manage and Install Plugins
3. Search for "PymHM"
4. Install and activate the plugin
5. Access the plugin from the Plugins menu
## Documentation
- [User Guide](https://github.com/SanjeevBashyal/pymhm/wiki)
- [API Reference](https://github.com/SanjeevBashyal/pymhm/wiki/API-Reference)
- [Examples](https://github.com/SanjeevBashyal/pymhm/tree/main/examples)
## Requirements
- Python 3.8+
- NumPy >= 1.20.0
- SciPy >= 1.7.0
- Pandas >= 1.3.0
- For QGIS plugin: QGIS 3.0+
## Development
### Setting up Development Environment
```bash
git clone https://github.com/SanjeevBashyal/pymhm.git
cd pymhm
pip install -e .[dev]
```
### Running Tests
```bash
pytest
```
### Building Documentation
```bash
pip install -e .[docs]
sphinx-build -b html docs/ docs/_build/
```
## Contributing
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## License
This project is licensed under the GNU General Public License v2.0 - see the [LICENSE](LICENSE) file for details.
## Citation
If you use PymHM in your research, please cite:
```bibtex
@software{pymhm2025,
title={PymHM: Python Mesoscale Hydrological Model},
author={Sanjeev Bashyal},
year={2025},
url={https://github.com/SanjeevBashyal/pymhm},
version={0.1.0}
}
```
## Support
- **Issues**: [GitHub Issues](https://github.com/SanjeevBashyal/pymhm/issues)
- **Discussions**: [GitHub Discussions](https://github.com/SanjeevBashyal/pymhm/discussions)
- **Email**: sanjeev.bashyal01@gmail.com
## Changelog
See [CHANGELOG.md](CHANGELOG.md) for a list of changes and version history.
## Acknowledgments
- QGIS Development Team for the excellent platform
- Python Scientific Community for the amazing tools
- Contributors and users of PymHM
Raw data
{
"_id": null,
"home_page": "https://github.com/SanjeevBashyal/pymhm",
"name": "pymhm",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Sanjeev Bashyal <sanjeev.bashyal01@gmail.com>",
"keywords": "hydrology, modeling, mesoscale, water, environment, qgis, plugin",
"author": "Sanjeev Bashyal",
"author_email": "Sanjeev Bashyal <sanjeev.bashyal01@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/b9/5a/5a5cf8e03b71310001ed7c45dc900be5bd39176a79cd2ce407916b73b4c2/pymhm-0.1.0.tar.gz",
"platform": null,
"description": "# PymHM - Python Mesoscale Hydrological Model\r\n\r\n[](https://www.python.org/downloads/)\r\n[](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)\r\n[](https://badge.fury.io/py/pymhm)\r\n\r\nA Python package for mesoscale hydrological modeling, designed to work both as a standalone library and as a QGIS plugin.\r\n\r\n## Features\r\n\r\n- **Hydrological Modeling**: Core functionality for mesoscale hydrological processes\r\n- **QGIS Integration**: Seamless integration with QGIS 3.0+ as a plugin\r\n- **Data Processing**: Tools for handling hydrological data and model inputs\r\n- **Visualization**: Built-in plotting and visualization capabilities\r\n- **Extensible**: Modular design for easy extension and customization\r\n\r\n## Installation\r\n\r\n### From PyPI (Recommended)\r\n\r\n```bash\r\npip install pymhm\r\n```\r\n\r\n### From Source\r\n\r\n```bash\r\ngit clone https://github.com/SanjeevBashyal/pymhm.git\r\ncd pymhm\r\npip install -e .\r\n```\r\n\r\n### For QGIS Plugin\r\n\r\n1. Download the plugin from the QGIS Plugin Manager\r\n2. Or install manually by copying the `pymhm` folder to your QGIS plugins directory\r\n\r\n## Quick Start\r\n\r\n### As a Python Package\r\n\r\n```python\r\nimport pymhm\r\n\r\n# Initialize the model\r\nmodel = pymhm.HydrologicalModel()\r\n\r\n# Run simulation\r\nresults = model.run_simulation()\r\n```\r\n\r\n### As a QGIS Plugin\r\n\r\n1. Open QGIS\r\n2. Go to Plugins \u2192 Manage and Install Plugins\r\n3. Search for \"PymHM\"\r\n4. Install and activate the plugin\r\n5. Access the plugin from the Plugins menu\r\n\r\n## Documentation\r\n\r\n- [User Guide](https://github.com/SanjeevBashyal/pymhm/wiki)\r\n- [API Reference](https://github.com/SanjeevBashyal/pymhm/wiki/API-Reference)\r\n- [Examples](https://github.com/SanjeevBashyal/pymhm/tree/main/examples)\r\n\r\n## Requirements\r\n\r\n- Python 3.8+\r\n- NumPy >= 1.20.0\r\n- SciPy >= 1.7.0\r\n- Pandas >= 1.3.0\r\n- For QGIS plugin: QGIS 3.0+\r\n\r\n## Development\r\n\r\n### Setting up Development Environment\r\n\r\n```bash\r\ngit clone https://github.com/SanjeevBashyal/pymhm.git\r\ncd pymhm\r\npip install -e .[dev]\r\n```\r\n\r\n### Running Tests\r\n\r\n```bash\r\npytest\r\n```\r\n\r\n### Building Documentation\r\n\r\n```bash\r\npip install -e .[docs]\r\nsphinx-build -b html docs/ docs/_build/\r\n```\r\n\r\n## Contributing\r\n\r\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.\r\n\r\n1. Fork the repository\r\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\r\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\r\n4. Push to the branch (`git push origin feature/amazing-feature`)\r\n5. Open a Pull Request\r\n\r\n## License\r\n\r\nThis project is licensed under the GNU General Public License v2.0 - see the [LICENSE](LICENSE) file for details.\r\n\r\n## Citation\r\n\r\nIf you use PymHM in your research, please cite:\r\n\r\n```bibtex\r\n@software{pymhm2025,\r\n title={PymHM: Python Mesoscale Hydrological Model},\r\n author={Sanjeev Bashyal},\r\n year={2025},\r\n url={https://github.com/SanjeevBashyal/pymhm},\r\n version={0.1.0}\r\n}\r\n```\r\n\r\n## Support\r\n\r\n- **Issues**: [GitHub Issues](https://github.com/SanjeevBashyal/pymhm/issues)\r\n- **Discussions**: [GitHub Discussions](https://github.com/SanjeevBashyal/pymhm/discussions)\r\n- **Email**: sanjeev.bashyal01@gmail.com\r\n\r\n## Changelog\r\n\r\nSee [CHANGELOG.md](CHANGELOG.md) for a list of changes and version history.\r\n\r\n## Acknowledgments\r\n\r\n- QGIS Development Team for the excellent platform\r\n- Python Scientific Community for the amazing tools\r\n- Contributors and users of PymHM\r\n",
"bugtrack_url": null,
"license": "GPL-2.0",
"summary": "Python package for mesoscale Hydrological Model",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/SanjeevBashyal/pymhm/issues",
"Documentation": "https://github.com/SanjeevBashyal/pymhm/wiki",
"Homepage": "https://github.com/SanjeevBashyal/pymhm",
"Repository": "https://github.com/SanjeevBashyal/pymhm"
},
"split_keywords": [
"hydrology",
" modeling",
" mesoscale",
" water",
" environment",
" qgis",
" plugin"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7ef9af2367405286802a4ea81757ad3f3832b7542380d5f8ee9b7db19c468006",
"md5": "a5b41279547004901f13412acf348a7a",
"sha256": "c2befc32c38b7cd04566a9478fdd910cff3483f7b660a6ce2f8785d46e6370ad"
},
"downloads": -1,
"filename": "pymhm-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a5b41279547004901f13412acf348a7a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 60509,
"upload_time": "2025-10-24T18:50:36",
"upload_time_iso_8601": "2025-10-24T18:50:36.870040Z",
"url": "https://files.pythonhosted.org/packages/7e/f9/af2367405286802a4ea81757ad3f3832b7542380d5f8ee9b7db19c468006/pymhm-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b95a5a5cf8e03b71310001ed7c45dc900be5bd39176a79cd2ce407916b73b4c2",
"md5": "ad6b2fe2598d75d2380a2ea30d447cfc",
"sha256": "c61b3f7f31271e7eaf267a7b5e24b9465157ee1afac4bb8a47251f2670daa0f2"
},
"downloads": -1,
"filename": "pymhm-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "ad6b2fe2598d75d2380a2ea30d447cfc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 54490,
"upload_time": "2025-10-24T18:50:38",
"upload_time_iso_8601": "2025-10-24T18:50:38.658250Z",
"url": "https://files.pythonhosted.org/packages/b9/5a/5a5cf8e03b71310001ed7c45dc900be5bd39176a79cd2ce407916b73b4c2/pymhm-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-24 18:50:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SanjeevBashyal",
"github_project": "pymhm",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"1.20.0"
]
]
},
{
"name": "scipy",
"specs": [
[
">=",
"1.7.0"
]
]
},
{
"name": "pandas",
"specs": [
[
">=",
"1.3.0"
]
]
},
{
"name": "matplotlib",
"specs": [
[
">=",
"3.3.0"
]
]
},
{
"name": "netCDF4",
"specs": [
[
">=",
"1.5.0"
]
]
},
{
"name": "xarray",
"specs": [
[
">=",
"0.19.0"
]
]
}
],
"lcname": "pymhm"
}
JSON
