LoopStructural: Loop3D Implicit Geological Modelling
Overview
LoopStructural is an opensource Python library for 3D geological modelling. The library has been built in the scope of the Loop project (Loop3d.org). LoopStructural can:
- Model fault networks integrating fault kinematics and overprinting relationships
- Model folds using structural elements (fold axis, fold axial surface) for multiple fold events
- Use different implicit interpolation algorithms (Finite Difference, Piecewiese Linear, RBF)
- Export models to vtk, geoh5, omf, gocad, csv, obj formats
- Visualise models in an interactive python environment.
Installation
Google colab
LoopStructural can be used inside a google colab notebook, however interactive visualisation using kitware trame does not work. Only static plots can be displayed.
Pip
pip install loopstructural
Optional dependencies are:
- loopstructuralvisualisation (wrapper for pyvista to interface with loopstructural objects)
- pyvista (3D visualisation)
- geoh5py (export to .geoh5 format)
- mira-omf (export to .omf format to load in Leapfrog)
- pyevtk
- dill (serialize loop models to a pickle file)
- tqdm (progress bars)
- loopsolver (experimental solver for admm inequality constraints)
You can install all of the optional dependencies using:
pip install loopstructural[all]
conda
conda install -c conda-forge -c loop3d loopstructural
to install the working 3D visualisation environment
conda install -c conda-forge -c loop3d loopstructural loopstructuralvisualisation pyvista trame trame-vtk trame-vuetify
Quickstart
- A basic geological model
from LoopStructural import GeologicalModel
from LoopStructural.geometry import BoundingBox
from LoopStructural.visualisation import Loop3DView
from LoopStructural.datasets import load_claudius
import numpy as np
data, bb = load_claudius()
#bb constaints origin and maximum of axis aligned bounding box
#data is a pandas dataframe with X,Y,Z,val,nx,ny,nz, feature_name
model = GeologicalModel(bb[0,:],bb[1,:])
model.data = data
# nelements specifies the number of discrete interpolation elements
# 'stratí' is the feature name in the data dataframe
model.create_and_add_foliation('strati',nelements=1e5)
model.update()
# get the value of the interpolator at some random locations
locations = np.array(
[
np.random.uniform(bb[0, 0], bb[1, 0],5),
np.random.uniform(bb[0, 1], bb[1, 1],5),
np.random.uniform(bb[0, 2], bb[1, 2],5),
]
).T
val = model.evaluate_feature_value('strati', locations)
# get the gradient of the interpolator
gradient = model.evaluate_feature_gradient('strati',locations)
#Plot the scalar field of the model
model['strati'].scalar_field().plot()
Documentation
The LoopStructural documentation can be found here
Problems
Any bugs/feature requests/comments please create a new issue.
Acknowledgements
The Loop platform is an open source 3D probabilistic geological and geophysical modelling platform, initiated by Geoscience Australia and the OneGeology consortium. The project is funded by Australian territory, State and Federal Geological Surveys, the Australian Research Council and the MinEx Collaborative Research Centre.
1 maintainer
Metadata
1 maintainer
Release files for LoopStructural 1.8.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| loopstructural-1.8.2.tar.gz | 493.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| loopstructural-1.8.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.0 MB
Release files / loopstructural-1.8.2.tar.gz
| Download URL | loopstructural-1.8.2.tar.gz |
|---|---|
| Size | 493.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f4486d584e0cbedab5f3261c66008bcb09d96539d119f303bdaec9c48c19fd71
|
|
BLAKE2b-256 checksum How to use checksums |
f34a2f93d4905dcf1dbf33f12ddc8ec927ec08355a2955a8aad969d59e7061c2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / loopstructural-1.8.2-py3-none-any.whl
| Download URL | loopstructural-1.8.2-py3-none-any.whl |
|---|---|
| Size | 538.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a82b7007fe376c0786f4cdc4d98281be21faeb371a5b512b5da621a4ce80eef3
|
|
BLAKE2b-256 checksum How to use checksums |
c9d7113a37254463d71ab99d2a7ccfc3b9510de9d5dd95b36d3289877040d546
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
