ArchPy

A hierarchical stochastic geological modeling tool in Python

Installation

ArchPy can be installed with pip :

pip install geoarchpy

This will install all ArchPy dependencies (even the optional ones) and the package itself.

OR

ArchPy can be installed with

pip install .

when in the main directory.

Alternatively, it is possible to add ArchPy path directly in the python script with sys :

sys.path.append("path where ArchPy is") 

and then import ArchPy. In such case, it is necessary to install all the dependencies manually.

⚠️ Issues with widgets: For some reasons, widgets does not work properly, probably due to the recent version of jupyter-server. For now these issues are not solved and widgets are not working, except partially with inline backend.

Concerning the interactivity of the plots, it is necessary to install trame as well as some trame subpackages. This can be done with the following command :

pip install trame
pip install trame-vuetify
pip install trame-vtk

Requirements

Works and tested with 3.8 <= python <= 3.11

The following python packages are absolutely necessary:

• Geone
• matplotlib
• numpy (tested with 1.23.5)
• SciPy
• sklearn
• pandas
• shapely
• scikit-learn

These are not required but highly recommanded. They are installed with ArchPy by default.

• PyVista
• pyyaml (for export uses)
• Rasterio (to use rasters)
• Geopandas (to use shapefile)
• ipywidgets

Examples

There is some example notebooks :

• 01_basic : a folder where simple and basics ArchPy functionnalities are described
• 02_3D_ArchPy : a complete 3D ArchPy model example
• 03_Article_example : a synthetical example shown in ArchPy article
• 04_hierarchies : an exemple with many hierarchical units to test ArchPy capabilities
• 05_mps_surfaces : an example how to use MPS to simulate the units surfaces
• 06_cross_validation : a notebook that present how to perform a cross-validation directly with ArchPy
• 07_geological_map : this notebook presents how to integrate and use a geological in an ArchPy model
• 08_inference : little guide how to use archpy inference tools to estimate surface parameters (no facies parameters for now) --> Note that for now, the interface is not working due to incompatibilities issues with ipywidgets.
• 09_interface : little exemple of an interface to call an preexisting archpy model as well as drawing a new model extension.

Paper

A paper was published on the ArchPy concept and its different capabilities. The paper was written with the version 0.1 of ArchPy. It is available with the following link.

Contact

For any questions regarding ArchPy, please contact me at ludovic.schorpp@unine.ch