Metadata-Version: 2.1
Name: pyhelp
Version: 0.5.0rc1
Summary: A Python library for the assessment of spatially distributed groundwater recharge and hydrological components with HELP.
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: Topic :: Scientific/Engineering
Project-URL: Homepage, https://github.com/cgq-qgc/pyhelp
Project-URL: Repository, https://github.com/cgq-qgc/pyhelp
Requires-Python: <3.14,>=3.11
Requires-Dist: numpy>=1.26
Requires-Dist: scipy>=1.9
Requires-Dist: pandas<3,>=2
Requires-Dist: h5py>=3
Requires-Dist: matplotlib>=3.6
Description-Content-Type: text/markdown

![PyHELP](https://raw.githubusercontent.com/cgq-qgc/pyhelp/master/images/pyhelp_banner_v2.png)

[![license](https://img.shields.io/pypi/l/pyhelp.svg)](./LICENSE)
[![Latest release](https://img.shields.io/github/release/cgq-qgc/pyhelp.svg)](https://github.com/cgq-qgc/pyhelp/releases)
[![Documentation Status](https://readthedocs.org/projects/pyhelp/badge/?version=latest)](http://pyhelp.readthedocs.io)
[![tests](https://github.com/cgq-qgc/pyhelp/actions/workflows/python-test.yml/badge.svg?branch=master)](https://github.com/cgq-qgc/pyhelp/actions/workflows/python-test.yml)
[![codecov](https://codecov.io/gh/cgq-qgc/pyhelp/branch/master/graph/badge.svg)](https://codecov.io/gh/cgq-qgc/pyhelp)

PyHELP is an object oriented Python library providing a set of tools to
estimate spatially distributed groundwater recharge and other hydrological
components (runoff and evapotranspiration) using the HELP
([Hydrologic Evaluation of Landfill Performance](https://www.epa.gov/land-research/hydrologic-evaluation-landfill-performance-help-model))
model.
PyHELP integrates weather data (from grids or stations), land conditions
defined by a series of GIS maps as well as soil and geological material
properties into HELP input files.
PyHELP also processes HELP simulation results and outputs them as
maps and graphs, including comparisons of simulation results with
stream hydrographs.
PyHELP thus accompanies users through the entire workflow from input file
assembly to model calibration and to the documentation of results.
This workflow is based on the method originally developed by
[Croteau et al. (2011)](https://www.tandfonline.com/doi/abs/10.4296/cwrj3504451)
to assess spatially distributed groundwater recharge at the regional scale.

Please consult the [documentation](http://pyhelp.readthedocs.io) for more
details.

## Installation
[![pypi version](https://img.shields.io/pypi/v/pyhelp.svg)](https://pypi.org/project/pyhelp/)

Pip Wheels are available for Python 3.11 to 3.13 on the Windows 64bits plateform. If you need to use PyHELP with a version of Python older than 3.11 or more recent than 3.13, or if you are working on Linux or macOS, you will have to build and install PyHELP from source.

To install PyHELP, along with all its dependencies, simply run the following command in a terminal:

`python -m pip install pyhelp`
