Metadata-Version: 2.1
Name: welltestpy
Version: 1.2.0
Summary: welltestpy - package to handle well-based Field-campaigns.
Project-URL: Homepage, https://github.com/GeoStat-Framework/welltestpy
Project-URL: Documentation, https://welltestpy.readthedocs.io
Project-URL: Source, https://github.com/GeoStat-Framework/welltestpy
Project-URL: Tracker, https://github.com/GeoStat-Framework/welltestpy/issues
Project-URL: Changelog, https://github.com/GeoStat-Framework/welltestpy/blob/main/CHANGELOG.md
Project-URL: Conda-Forge, https://anaconda.org/conda-forge/welltestpy
Author-email: "Sebastian Müller, Jarno Herrmann" <info@geostat-framework.org>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Requires-Python: >=3.7
Requires-Dist: anaflow>=1.0.0
Requires-Dist: matplotlib>=3.0.0
Requires-Dist: numpy>=1.14.5
Requires-Dist: packaging>=20
Requires-Dist: scipy>=1.1.0
Requires-Dist: spotpy>=1.5.0
Provides-Extra: check
Requires-Dist: black<24,>=23; extra == 'check'
Requires-Dist: isort[colors]<6; extra == 'check'
Requires-Dist: pylint<3; extra == 'check'
Provides-Extra: doc
Requires-Dist: m2r2>=0.2.8; extra == 'doc'
Requires-Dist: numpydoc>=1.1; extra == 'doc'
Requires-Dist: sphinx-gallery>=0.8; extra == 'doc'
Requires-Dist: sphinx-rtd-theme<1.1,>=1; extra == 'doc'
Requires-Dist: sphinx>=4; extra == 'doc'
Provides-Extra: test
Requires-Dist: pytest-cov>=3; extra == 'test'
Description-Content-Type: text/markdown

# Welcome to welltestpy

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1229051.svg)](https://doi.org/10.5281/zenodo.1229051)
[![PyPI version](https://badge.fury.io/py/welltestpy.svg)](https://badge.fury.io/py/welltestpy)
[![Build Status](https://github.com/GeoStat-Framework/welltestpy/workflows/Continuous%20Integration/badge.svg?branch=main)](https://github.com/GeoStat-Framework/welltestpy/actions)
[![Coverage Status](https://coveralls.io/repos/github/GeoStat-Framework/welltestpy/badge.svg?branch=main)](https://coveralls.io/github/GeoStat-Framework/welltestpy?branch=main)
[![Documentation Status](https://readthedocs.org/projects/welltestpy/badge/?version=latest)](https://geostat-framework.readthedocs.io/projects/welltestpy/en/latest/?badge=latest)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

<p align="center">
<img src="https://raw.githubusercontent.com/GeoStat-Framework/welltestpy/main/docs/source/pics/WTP.png" alt="welltestpy-LOGO" width="251px"/>
</p>

## Purpose

welltestpy provides a framework to handle, process, plot and analyse data from well based field campaigns.


## Installation

You can install the latest version with the following command:

    pip install welltestpy

Or from conda

    conda install -c conda-forge welltestpy


## Documentation for welltestpy

You can find the documentation including tutorials and examples under
https://welltestpy.readthedocs.io.


## Citing welltestpy

If you are using this package you can cite our
[Groundwater publication](https://doi.org/10.1111/gwat.13121) by:

> Müller, S., Leven, C., Dietrich, P., Attinger, S. and Zech, A. (2021):
> How to Find Aquifer Statistics Utilizing Pumping Tests? Two Field Studies Using welltestpy.
> Groundwater, https://doi.org/10.1111/gwat.13121

To cite the code, please visit the [Zenodo page](https://doi.org/10.5281/zenodo.1229051).


## Provided Subpackages

```python
welltestpy.data      # Subpackage to handle data from field campaigns
welltestpy.estimate  # Subpackage to estimate field parameters
welltestpy.process   # Subpackage to pre- and post-process data
welltestpy.tools     # Subpackage with tools for plotting and triagulation
```


## Requirements

- [NumPy >= 1.14.5](https://www.numpy.org)
- [SciPy >= 1.1.0](https://www.scipy.org)
- [AnaFlow >= 1.0.0](https://github.com/GeoStat-Framework/AnaFlow)
- [SpotPy >= 1.5.0](https://github.com/thouska/spotpy)
- [Matplotlib >= 3.0.0](https://matplotlib.org)


## Contact

You can contact us via <info@geostat-framework.org>.


## License

[MIT](https://github.com/GeoStat-Framework/welltestpy/blob/main/LICENSE)
