Karstnet is a python3 project providing tools for the statistical analysis of karstic networks.
Version 1.1.0 - August 2020
Download karstnet from this Github platform : green button "clone or download". Then, unzip it on your computer.
Once this have been done, you can open a Python prompt (like the Anaconda prompt) to install it
Install from source (from project main directory), just to use it (e.g. in Jupyter notebooks):
1)In your prompt, go to your directory location (ex:
cd C:\Users\YourName\Documents\KARSTNET\karstnet
- then launch karstnet installation by taping:
pip install .Do not forget the point "." at the end of the command
If you want to run it directly from source (useful for development):
pip install -e .
Both these options can also be run without moving previously in the karstnet folder. In that case, just type in your Anaconda prompt :
pip install -e your\path\to\karstnet
From source directory, and after instaling karstnet run:
pytest tests/test_karstnet.py
Example of jupyter notebooks are provided to help you use karstnet. To use karstnet in notebooks, you just have to write
import karstnet as kn
A call-test function is available to help you check if the package is ready to use : just type:
kn.test_kn()
The html documentation is available in the sub directory: docs/_build/html/index.html
Also available online at: https://karstnet.readthedocs.io/
The karstnet package implements the statistical metrics that were investigated and discussed in: Collon, P., Bernasconi D., Vuilleumier C., and Renard P., 2017, Statistical metrics for the characterization of karst network geometry and topology. Geomorphology. 283: 122-142 doi:10.1016/j.geomorph.2017.01.034 http://dx.doi.org/doi:10.1016/j.geomorph.2017.01.034
The paper can be downloaded here http://members.unine.ch/philippe.renard/articles/collon2017.pdf or here https://hal.univ-lorraine.fr/hal-01468055v1.