Metadata-Version: 2.4
Name: loopstructuralvisualisation
Version: 0.2.2
Summary: 3D geological modelling visualisation for LoopStructural
Author-email: Lachlan Grose <lachlan.grose@monash.edu>
License: MIT
Project-URL: Documentation, https://Loop3d.org/LoopStructural/
Project-URL: Bug Tracker, https://github.com/loop3d/loopstructural-visualisation/issues
Project-URL: Source Code, https://github.com/loop3d/loopstructural-visualisation
Keywords: earth sciences,geology,3-D modelling,structural geology,uncertainty
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.18
Requires-Dist: matplotlib>=3.6
Requires-Dist: pyvista>=0.44
Requires-Dist: LoopStructural>=1.8.0
Provides-Extra: jupyter
Requires-Dist: pyvista[jupyter]; extra == "jupyter"
Provides-Extra: all
Requires-Dist: pyvista[all]; extra == "all"
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Dynamic: license-file

# loopstructural-visualisation

A LoopStructural interface for pyvista's Plotter class.

The viewer uses the current LoopStructural geometry and stratigraphic-column
APIs. Feature evaluation takes world coordinates; the viewer does not apply an
additional model-coordinate transform. Notebook integration supports both
PyVista's original Trame modules and the newer `trame-pyvista` package.

Compatibility checked on Windows with Python 3.13 and workspace LoopStructural
1.8.4:

| VTK | PyVista | Checks |
| --- | --- | --- |
| 9.7.1 | 0.49.1 | Core plotting, off-screen rendering, clipping, notebook UI |
| 9.6.2 | 0.48.4 | Core plotting, off-screen rendering, clipping |

CI also runs the plotting and notebook tests on Windows and Linux against the
VTK 9.6 and 9.7 release lines with the latest compatible PyVista.

From the workspace root, run the tests with:

```sh
uv sync --package loopstructuralvisualisation --extra tests --extra jupyter
uv run --no-sync pytest packages/loopstructural_visualisation/tests
```


To install `pip install loopstructuralvisualisation` or for a jupyter notebook environment (including the pyvista[jupyuter] dependencies) `pip install loopstructuralvisualisation[jupyter]`

