Metadata-Version: 2.1
Name: pykasso
Version: 0.1.2
Summary: Python project intended to simulate stochastic karst network
Home-page: https://github.com/randlab/pyKasso
License: GPL-3.0
Keywords: hydrogeology,3-D modeling,stochasticity
Author: François Miville
Author-email: francois@miville.org
Maintainer: François Miville
Maintainer-email: francois@miville.org
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Provides-Extra: analysis
Provides-Extra: visualization
Requires-Dist: agd (>=0.1.31,<0.2.0)
Requires-Dist: imageio (>=2.26.1,<3.0.0) ; extra == "visualization"
Requires-Dist: matplotlib (>=3.6.2,<4.0.0)
Requires-Dist: mplstereonet (>=0.6.2,<0.7.0) ; extra == "analysis"
Requires-Dist: mpmath (>=1.2.1,<2.0.0)
Requires-Dist: networkx (>=3.0,<4.0) ; extra == "analysis"
Requires-Dist: numpy (>=1.22.0,<2.0.0)
Requires-Dist: openpyxl (>=3.0.10,<4.0.0)
Requires-Dist: pandas (>=1.5.2,<2.0.0)
Requires-Dist: plotly (>=5.13.1,<6.0.0)
Requires-Dist: pyvista (>=0.37.0,<0.38.0) ; extra == "visualization"
Requires-Dist: pyyaml (>=6.0,<7.0)
Requires-Dist: scipy (>=1.9.3,<2.0.0)
Project-URL: Repository, https://github.com/randlab/pyKasso
Description-Content-Type: text/markdown

![pyKasso's banner](/docs/source/_static/pykasso_banner_logo.png)

<!-- ![]() -->
[![PyPI Version](https://img.shields.io/pypi/v/pykasso.png)](https://pypi.python.org/pypi/pykasso)
[![PyPI Status](https://img.shields.io/pypi/status/pykasso.png)](https://pypi.python.org/pypi/pykasso)
[![PyPI Versions](https://img.shields.io/pypi/pyversions/pykasso.png)](https://pypi.python.org/pypi/pykasso)

![license](https://img.shields.io/github/license/randlab/pyKasso)
![last-commit](https://img.shields.io/github/last-commit/randlab/pyKasso/dev)

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/randlab/pyKasso/dev)

## pyKasso: a stochastic karst network simulation tool
<!-- ![pyKasso's logo](/docs/source/_static/pykasso_logo.png) -->

pyKasso is a python3 open-source package intended to simulate easily and quickly karst networks using a geological model, hydrogeological, and structural data. It relies on a pseudo-genetic methodology where stochastic data and fast-marching methods are combined to perform thousands of simulations rapidly. The method is based on the stochastic karst simulator developed by Borghi et al (2012). It has been extended to account for anisotropy allowing to simplify the algorithm while accounting better for the geological structure following the method presented in Fandel et al. (2022). Statistical geometrical and topological metrics are computed on the simulated networks and compared with the same statistics computed on real karst network to evaluate the plausibility of the simulations.

![gif_01](/docs/source/_static/animation_01.gif)
![gif_02](/docs/source/_static/animation_02.gif)

## Installation

Currently, pyKasso is only working with Python 3.9.

### Using conda

Download *environment.yml*. From source:
```
conda env create --name pykasso --file=environment.yml
```

Then:
```
pip install -e pykasso[analysis, visualization]
```

### Check installation

Work in progress.

<!-- ```
poetry run pytest tests/
``` -->

### Dependencies

pyKasso requires the following python packages to function properly:
- [agd](https://github.com/Mirebeau/AdaptiveGridDiscretizations)
- [karstnet](https://github.com/UniNE-CHYN/karstnet)
- [pyvista](https://github.com/pyvista/pyvista)

## Documentation

Work in progress.

## Examples

Some basic examples are avaible here : [notebooks/geometry/](https://github.com/randlab/pyKasso/tree/dev/notebooks/geometry)

## Contact

- F. Miville
- Prof. C. Fandel
- Prof. P. Renard

## Publications

- Fandel, C., Miville, F., Ferré, T. et al. 2022: The stochastic simulation of karst conduit network structure using anisotropic fast marching, and its application to a geologically complex alpine karst system. Hydrogeol J 30, 927–946, https://doi.org/10.1007/s10040-022-02464-x
- Borghi, A., Renard, P., Jenni, S. 2012: A pseudo-genetic stochastic model to generate karstic networks, Journal of Hydrology, 414–415, https://doi.org/10.1016/j.jhydrol.2011.11.032.
