Metadata-Version: 2.4
Name: andfn
Version: 0.1.11
Summary: An analytic element model for discrete fracture networks
Author: Erik A.L. Toller
Maintainer-email: "Erik A.L. Toller" <erik@toller.se>
License: MIT License
        
        Copyright (c) 2024 Erik Åke Ludvig Toller
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://eriktoller.github.io/andfn
Project-URL: Documentation, https://eriktoller.github.io/andfn
Project-URL: Repository, https://github.com/eriktoller/andfn
Project-URL: Issues, https://github.com/eriktoller/andfn/issues
Keywords: hydrology,groundwater,model,analytic element method,discrete fracture network,dfn
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Hydrology
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pyvista~=0.44.2
Requires-Dist: scipy
Requires-Dist: numba
Requires-Dist: h5py
Requires-Dist: matplotlib
Provides-Extra: all
Requires-Dist: pyyaml; extra == "all"
Requires-Dist: pandas; extra == "all"
Requires-Dist: matplotlib; extra == "all"
Dynamic: license-file

# AnDFN, Analytical Discrete Fracture Network

## Introduction
AnDFN is a computer program for the modelling of groundwater flow in a discrete fracture network (DFN). The program is based on the Analytic Element Method (AEM) and is distributed as a Python package with various modules and scripts.

The documentation for AnDFN is available [here](https://eriktoller.github.io/andfn/).

## Installation
AnDFN can be installed from PyPi.

Installation:
```
pip install andfn
```

Update:
```
pip install andfn --upgrade
```

Uninstall
```
pip uninstall andfn
```

### Dependencies
`andfn` has the following required dependencies:
- `numpy`
- `pandas`
- `scipy`
- `pyvista`
- `numba`
- `h5py`

and the following optional dependencies:
- `pyyaml` (for using the YAML configuration file)
- `matplotlib` (for some optional plots)

## Functionality
AnDFN currently have the following functionality:
- Generate random DFN
- Compute the intersections of a DFN
- Solve the AEM model for a DFN
- Plot the flow net for the AEM model
- Import DFNs
- Load and save DFNs

## Getting started
A template for a simple AnDFN model and several examples are available in the `examples` folder (under development).

## Citation
The basic theory for this program is published in:

Otto D.L. Strack, Erik A.L. Toller, An analytic element model for flow in fractured impermeable rock, *Journal of Hydrology*, 2024, 131983, ISSN 0022-1694, https://doi.org/10.1016/j.jhydrol.2024.131983.

## Acknowledgements
The original development of this code was funded by [BeFo](https://www.befo.se) (Stiftelsen Bergteknisk Forskning) grant number 529.
