Metadata-Version: 1.1
Name: anaflow
Version: 0.4.0
Summary:  AnaFlow - analytical solutions for the groundwater-flow equation
Home-page: https://github.com/GeoStat-Framework/AnaFlow
Author: Sebastian Mueller
Author-email: sebastian.mueller@ufz.de
License: GPL - see LICENSE
Description-Content-Type: text/markdown
Description: # Welcome to AnaFlow
        
        [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1135723.svg)](https://doi.org/10.5281/zenodo.1135723)
        [![PyPI version](https://badge.fury.io/py/anaflow.svg)](https://badge.fury.io/py/anaflow)
        [![Build Status](https://travis-ci.org/GeoStat-Framework/AnaFlow.svg?branch=master)](https://travis-ci.org/GeoStat-Framework/AnaFlow)
        [![Documentation Status](https://readthedocs.org/projects/docs/badge/?version=latest)](https://anaflow.readthedocs.io/en/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/AnaFlow/master/docs/source/pics/Anaflow.png" alt="AnaFlow-LOGO" width="251px"/>
        </p>
        
        ## Purpose
        
        AnaFlow provides several analytical and semi-analytical solutions for the
        groundwater-flow equation.
        
        
        ## Installation
        
        You can install the latest version with the following command:
        
            pip install anaflow
        
        
        ## Documentation for AnaFlow
        
        You can find the documentation under [geostat-framework.readthedocs.io][doc_link].
        
        
        ### Example
        
        In the following the well known Theis function is called an plotted for three
        different time-steps.
        
        ```python
        import numpy as np
        from matplotlib import pyplot as plt
        from anaflow import theis
        
        
        time = [10, 100, 1000]
        rad = np.geomspace(0.1, 10)
        
        head = theis(time=time, rad=rad, T=1e-4, S=1e-4, Qw=-1e-4)
        
        for i, step in enumerate(time):
            plt.plot(rad, head[i], label="Theis(t={})".format(step))
        
        plt.legend()
        plt.show()
        ```
        
        <p align="center">
        <img src="https://raw.githubusercontent.com/GeoStat-Framework/AnaFlow/master/docs/source/pics/01_call_theis.png" alt="Theis" width="600px"/>
        </p>
        
        
        ### Provided Functions
        
        The following functions are provided directly
        
        ```python
        anaflow.thiem        # Thiem solution for steady state pumping
        anaflow.theis        # Theis solution for transient pumping
        anaflow.ext_thiem2D  # extended Thiem solution in 2D
        anaflow.ext_theis2D  # extended Theis solution in 2D
        anaflow.ext_thiem3D  # extended Thiem solution in 3D
        anaflow.ext_theis3D  # extended Theis solution in 3D
        anaflow.grf_model    # "General Radial Flow" Model
        anaflow.grf_dist     # extended "General Radial Flow" Model on disks
        ```
        
        
        ### Laplace Transformation
        
        We provide routines to calculate the laplace-transformation as well as the
        inverse laplace-transformation of a given function
        
        ```python
        anaflow.get_lap      # Get the laplace transformation of a function
        anaflow.get_lap_inv  # Get the inverse laplace transformation of a function
        ```
        
        
        ## Requirements
        
        - [NumPy >= 1.13.0](https://www.numpy.org)
        - [SciPy >= 0.19.1](https://www.scipy.org)
        - [pentapy](https://github.com/GeoStat-Framework/pentapy)
        
        
        ## Contact
        
        You can contact us via <info@geostat-framework.org>.
        
        
        ## License
        
        [GPL][gpl_link] © 2019
        
        [gpl_link]: https://github.com/GeoStat-Framework/AnaFlow/blob/master/LICENSE
        [ogs5_link]: https://www.opengeosys.org/ogs-5/
        [doc_link]: https://geostat-framework.readthedocs.io/projects/anaflow/en/latest/
        
Platform: Windows
Platform: Linux
Platform: Mac OS-X
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
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 :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
