Merge pull request #26 from GeoStat-Framework/readme_update

update README

Author: MuellerSeb

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to **welltestpy** will be documented in this file.
 
-## [Unreleased]
+## [1.1.0] - 2021-07
 
 ### Enhancements
 - added `cooper_jacob_correction` to `process` (thanks to Jarno Herrmann)
@@ -16,6 +16,8 @@ All notable changes to **welltestpy** will be documented in this file.
 - removed `setup.py` (use `pip>21.1` for editable installs)
 - removed `dev` as extra install dependencies
 - better exceptions in loading routines
+- removed pandas dependency
+- simplified readme
 
 ### Bugfixes
 - loading steady pumping tests was not possible due to a bug
@@ -110,7 +112,8 @@ All notable changes to **welltestpy** will be documented in this file.
 
 First alpha release of welltespy.
 
-[Unreleased]: https://github.com/GeoStat-Framework/welltestpy/compare/v1.0.3...HEAD
+[Unreleased]: https://github.com/GeoStat-Framework/welltestpy/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/GeoStat-Framework/welltestpy/compare/v1.0.3...v1.1.0
 [1.0.3]: https://github.com/GeoStat-Framework/welltestpy/compare/v1.0.2...v1.0.3
 [1.0.2]: https://github.com/GeoStat-Framework/welltestpy/compare/v1.0.1...v1.0.2
 [1.0.1]: https://github.com/GeoStat-Framework/welltestpy/compare/v1.0.0...v1.0.1

README.md

@@ -22,79 +22,30 @@ You can install the latest version with the following command:
 
     pip install welltestpy
 
+Or from conda
 
-## Documentation for welltestpy
-
-You can find the documentation under [https://welltestpy.readthedocs.io][doc_link].
-
-
-### Example 1: A campaign containing a pumping test
-
-In the following, we will take a look at an artificial pumping test campaign,
-that is stored in a file called `Cmp_UFZ-campaign.cmp`.
-
-```python
-import welltestpy as wtp
-
-# load the campaign
-campaign = wtp.load_campaign("Cmp_UFZ-campaign.cmp")
-
-# plot the well constellation and a test overview
-campaign.plot_wells()
-campaign.plot()
-```
-
-#### This will give the following plots:
-
-<p align="center">
-<img src="https://raw.githubusercontent.com/GeoStat-Framework/welltestpy/main/docs/source/pics/01_wells.png" alt="Wells" width="600px"/>
-</p>
-
-<p align="center">
-<img src="https://raw.githubusercontent.com/GeoStat-Framework/welltestpy/main/docs/source/pics/01_pumptest.png" alt="Pumptest" width="600px"/>
-</p>
+    conda install -c conda-forge welltestpy
 
 
-### Example 2: Estimate transmissivity and storativity
-
-The pumping test from example 1 can now be loaded and used to estimate the values for
-transmissivity and storativity.
-
-```python
-import welltestpy as wtp
-
-campaign = wtp.load_campaign("Cmp_UFZ-campaign.cmp")
-estimation = wtp.estimate.Theis("Estimate_theis", campaign, generate=True)
-estimation.run()
-```
-
-#### This will give the following plots:
-
-Type-Curve fitting:
-
-<p align="center">
-<img src="https://raw.githubusercontent.com/GeoStat-Framework/welltestpy/main/docs/source/pics/02_fit.png" alt="Fit" width="600px"/>
-</p>
+## Documentation for welltestpy
 
-Evolution of parameter estimation with SCE:
+You can find the documentation including tutorials and examples under
+https://welltestpy.readthedocs.io.
 
-<p align="center">
-<img src="https://raw.githubusercontent.com/GeoStat-Framework/welltestpy/main/docs/source/pics/02_paratrace.png" alt="Trace" width="600px"/>
-</p>
 
-Scatterplot of paramter distribution during estimation:
+## Citing welltestpy
 
-<p align="center">
-<img src="https://raw.githubusercontent.com/GeoStat-Framework/welltestpy/main/docs/source/pics/02_parainter.png" alt="Interaction" width="600px"/>
-</p>
+If you are using this package you can cite our
+[Groundwater publication](https://doi.org/10.1111/gwat.13121) by:
 
-The results are:
+> 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
 
-* `ln(T) = -9.22` which is equivalent to `T = 0.99 * 10^-4 m^2/s`
-* `ln(S) = -9.10` which is equivalent to `S = 1.11 * 10^-4`
+To cite the code, please visit the [Zenodo page](https://doi.org/10.5281/zenodo.1229051).
 
 
-### Provided Subpackages
+## Provided Subpackages
 
 ```python
 welltestpy.data      # Subpackage to handle data from field campaigns
@@ -108,7 +59,6 @@ welltestpy.tools     # Subpackage with tools for plotting and triagulation
 
 - [NumPy >= 1.14.5](https://www.numpy.org)
 - [SciPy >= 1.1.0](https://www.scipy.org)
-- [Pandas >= 0.23.2](https://pandas.pydata.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)
@@ -121,7 +71,4 @@ You can contact us via <info@geostat-framework.org>.
 
 ## License
 
-[MIT][license_link] © 2018-2021
-
-[license_link]: https://github.com/GeoStat-Framework/welltestpy/blob/main/LICENSE
-[doc_link]: https://welltestpy.readthedocs.io
+[MIT](https://github.com/GeoStat-Framework/welltestpy/blob/main/LICENSE)

docs/source/index.rst

@@ -1,51 +1 @@
-=====================
-welltestpy Quickstart
-=====================
-
-.. image:: pics/WTP.png
-   :width: 150px
-   :align: center
-
-welltestpy provides a framework to handle, process, plot and analyse data from well based field campaigns.
-
-
-Installation
-============
-
-The package can be installed via `pip <https://pypi.org/project/welltestpy/>`_.
-On Windows you can install `WinPython <https://winpython.github.io/>`_ to get
-Python and pip running.
-
-.. code-block:: none
-
-    pip install welltestpy
-
-
-Provided Subpackages
-====================
-
-The following functions are provided directly
-
-.. code-block:: 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>`_
-- `Pandas >= 0.23.2 <https://pandas.pydata.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>`_
-
-
-License
-=======
-
-`MIT <https://github.com/GeoStat-Framework/welltestpy/blob/main/LICENSE>`_
+.. mdinclude:: ../../README.md