geoh5vista 0.2__tar.gz

geoh5vista-0.2/.gitignore

@@ -0,0 +1,19 @@
+**/.DS_Store
+**/*.pyc
+**/__pycache__/
+# pixi environments
+.pixi/
+.vscode/
+.github/
+.envrc
+.coverage
+coverage.xml
+pixi.lock
+assets/
+build/
+dist/
+docs/
+examples/
+tests/
+archive/
+src/geoh5vista.egg-info/

geoh5vista-0.2/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Derek Kinakin
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

geoh5vista-0.2/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: geoh5vista
+Version: 0.2
+Summary: A Python library for converting geoh5py objects to PyVista data objects for 3D visualization and geometry processing.
+Project-URL: Documentation, https://github.com/derek-kinakin/geoh5vista#readme
+Project-URL: Issues, https://github.com/derek-kinakin/geoh5vista/issues
+Project-URL: Source, https://github.com/derek-kinakin/geoh5vista
+Author: Derek Kinakin
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: 3d-visualization,geoh5,geology,geoscience,pyvista
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.12
+Requires-Dist: geoh5py>=0.13
+Requires-Dist: numpy>=1.26
+Requires-Dist: pyvista>=0.48
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: twine>=5; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=4; extra == 'test'
+Requires-Dist: pytest>=7; extra == 'test'
+Description-Content-Type: text/markdown
+
+geoh5vista: a Geoh5 <> PyVista (VTK) interface
+===========================================
+
+A PyVista (and VTK) interface for the `Geoh5` file format providing Python 3D visualization and useable data structures for processing datasets in the geoh5 specification. This library allows geologists to access the powerful tools available in the PyVista ecosystem for their data stored in the `Geoh5` format.
+
+The structure and interfaces of this project are heavily inspired by the 'omfvista' package, which provides a similar interface for the 'omf' format.
+
+omfvista package: <https://github.com/OpenGeoVis/omfvista>
+
+Geoh5 Python interface package: <https://mirageoscience-geoh5py.readthedocs-hosted.com/en/stable/index.html>
+
+Documentation is hosted at <https://github.com/derek-kinakin/geoh5vista>
+
+Installation
+------------
+
+From PyPi (coming soon)
+
+```python
+pip install geoh5vista
+```
+
+From Github
+
+```python
+pip install git+https://github.com/derek-kinakin/geoh5vista.git
+```
+
+Current Status of Supported Geoh5 Entities
+-------------------
+
+This table provides the list of supported entities. Read from and write
+to Geoh5 support is the goal for each entity.
+
+| Geoh5 Entity | PyVista Object             | Read from Geoh5 | Write to Geoh5 | Notes                                                         |
+| -------------|----------------------------|-----------------|----------------|---------------------------------------------------------------|
+| Workspace    | MultiBlock                 | Yes             | Yes            | A multiblock containing several object can be written to Geoh5|
+| Points       | PointSet                   | Yes             | Yes            |                                                               |
+| Curve        | PolyData                   | Yes             | Yes            |                                                               |
+| Surface      | PolyData                   | Yes             | Yes            |                                                               |
+| 2D Grid      | ImageData                  | Yes             | Yes            | 2D grid with dimensions nU x nV x 1                           |
+| Block model  | ImageData or StructuredGrid| Yes             | Yes            | 3D grid with dimensions nU x nV x nZ                          |
+| Drillholes   | PolyData                   | Yes             | No             | Drillholes can be round-tripped back to geoh5 as curves       |
+| Slicer       | PolyData                   | Yes             | No             | Geometry available as object metadata                         |
+
+Example Use
+-----------
+
+```python
+import pyvista as pv
+import geoh5vista
+
+project = geoh5vista.read_geoh5('test_file.geoh5')
+project
+```
+
+Once the data is loaded as a ``pyvista.MultiBlock`` dataset from ``geoh5vista``,
+that object can be directly used for interactive 3D visualization from PyVista:
+
+An interactive scene can be created and manipulated to create a figure.
+First, grab the elements from the project:
+
+```python
+# Grab a few elements of interest and plot em up!
+vol = project["Block Model"]
+topo = project["Topography"]
+dacite = project["Dacite"]
+```
+
+Then create a 3D scene with these spatial data and apply a filtering tool from
+PyVista to the volumetric data:
+
+```python
+# Create a plotting window
+p = pv.Plotter(notebook=False)
+# Add our datasets
+p.add_mesh(topo, cmap="gist_earth", opacity=0.5)
+p.add_mesh(dacite, color=dacite["gh5_colour"], opacity=0.6)
+# Add the volumetric dataset with a thresholding tool
+p.add_mesh_threshold(vol)
+# Add the bounds axis
+p.show_bounds()
+# Render the scene in a pop out window
+p.show()
+```
+
+Writing PyVista objects to a Geoh5 file can be as simple as:
+
+```python
+
+# Write a single object to geoh5
+geoh5vista.write_geoh5(topo, "new_gh5_topo_file.geoh5")
+
+# Write a multiblock to geoh5
+new_project = pv.MultiBlock()
+new_project["Topo"] = topo
+new_project["Dacite"] = dacite
+
+geoh5vista.write_geoh5(new_project, "new_project.geoh5")
+```

geoh5vista-0.2/README.md

@@ -0,0 +1,100 @@
+geoh5vista: a Geoh5 <> PyVista (VTK) interface
+===========================================
+
+A PyVista (and VTK) interface for the `Geoh5` file format providing Python 3D visualization and useable data structures for processing datasets in the geoh5 specification. This library allows geologists to access the powerful tools available in the PyVista ecosystem for their data stored in the `Geoh5` format.
+
+The structure and interfaces of this project are heavily inspired by the 'omfvista' package, which provides a similar interface for the 'omf' format.
+
+omfvista package: <https://github.com/OpenGeoVis/omfvista>
+
+Geoh5 Python interface package: <https://mirageoscience-geoh5py.readthedocs-hosted.com/en/stable/index.html>
+
+Documentation is hosted at <https://github.com/derek-kinakin/geoh5vista>
+
+Installation
+------------
+
+From PyPi (coming soon)
+
+```python
+pip install geoh5vista
+```
+
+From Github
+
+```python
+pip install git+https://github.com/derek-kinakin/geoh5vista.git
+```
+
+Current Status of Supported Geoh5 Entities
+-------------------
+
+This table provides the list of supported entities. Read from and write
+to Geoh5 support is the goal for each entity.
+
+| Geoh5 Entity | PyVista Object             | Read from Geoh5 | Write to Geoh5 | Notes                                                         |
+| -------------|----------------------------|-----------------|----------------|---------------------------------------------------------------|
+| Workspace    | MultiBlock                 | Yes             | Yes            | A multiblock containing several object can be written to Geoh5|
+| Points       | PointSet                   | Yes             | Yes            |                                                               |
+| Curve        | PolyData                   | Yes             | Yes            |                                                               |
+| Surface      | PolyData                   | Yes             | Yes            |                                                               |
+| 2D Grid      | ImageData                  | Yes             | Yes            | 2D grid with dimensions nU x nV x 1                           |
+| Block model  | ImageData or StructuredGrid| Yes             | Yes            | 3D grid with dimensions nU x nV x nZ                          |
+| Drillholes   | PolyData                   | Yes             | No             | Drillholes can be round-tripped back to geoh5 as curves       |
+| Slicer       | PolyData                   | Yes             | No             | Geometry available as object metadata                         |
+
+Example Use
+-----------
+
+```python
+import pyvista as pv
+import geoh5vista
+
+project = geoh5vista.read_geoh5('test_file.geoh5')
+project
+```
+
+Once the data is loaded as a ``pyvista.MultiBlock`` dataset from ``geoh5vista``,
+that object can be directly used for interactive 3D visualization from PyVista:
+
+An interactive scene can be created and manipulated to create a figure.
+First, grab the elements from the project:
+
+```python
+# Grab a few elements of interest and plot em up!
+vol = project["Block Model"]
+topo = project["Topography"]
+dacite = project["Dacite"]
+```
+
+Then create a 3D scene with these spatial data and apply a filtering tool from
+PyVista to the volumetric data:
+
+```python
+# Create a plotting window
+p = pv.Plotter(notebook=False)
+# Add our datasets
+p.add_mesh(topo, cmap="gist_earth", opacity=0.5)
+p.add_mesh(dacite, color=dacite["gh5_colour"], opacity=0.6)
+# Add the volumetric dataset with a thresholding tool
+p.add_mesh_threshold(vol)
+# Add the bounds axis
+p.show_bounds()
+# Render the scene in a pop out window
+p.show()
+```
+
+Writing PyVista objects to a Geoh5 file can be as simple as:
+
+```python
+
+# Write a single object to geoh5
+geoh5vista.write_geoh5(topo, "new_gh5_topo_file.geoh5")
+
+# Write a multiblock to geoh5
+new_project = pv.MultiBlock()
+new_project["Topo"] = topo
+new_project["Dacite"] = dacite
+
+geoh5vista.write_geoh5(new_project, "new_project.geoh5")
+```

geoh5vista-0.2/pyproject.toml

@@ -0,0 +1,102 @@
+[project]
+name = "geoh5vista"
+version = "0.2"
+description = "A Python library for converting geoh5py objects to PyVista data objects for 3D visualization and geometry processing."
+readme = { file = "README.md", content-type = "text/markdown" }
+requires-python = ">=3.12"
+license = "BSD-3-Clause"
+
+keywords = ["geoscience", "geoh5", "pyvista", "3d-visualization", "geology"]
+
+authors = [
+  { name = "Derek Kinakin" },
+]
+
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: BSD License",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Topic :: Scientific/Engineering",
+]
+
+dependencies = [
+  "geoh5py>=0.13",
+  "numpy>=1.26",
+  "pyvista>=0.48",
+]
+
+[project.optional-dependencies]
+test = ["pytest>=7", "pytest-cov>=4"]
+dev = ["ruff>=0.6", "pytest>=7", "pytest-cov>=4", "twine>=5"]
+
+[project.urls]
+Documentation = "https://github.com/derek-kinakin/geoh5vista#readme"
+Issues = "https://github.com/derek-kinakin/geoh5vista/issues"
+Source = "https://github.com/derek-kinakin/geoh5vista"
+
+[build-system]
+requires = ["hatchling>=1.25"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/geoh5vista"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "src/geoh5vista",
+  "tests",
+  "README.md",
+  "LICENSE",
+  "pyproject.toml",
+]
+
+[tool.hatch.envs.default]
+features = ["dev"]
+python = "3.12"
+
+[tool.hatch.envs.default.scripts]
+test = "pytest"
+test-cov = "pytest --cov=src/geoh5vista --cov-report=term-missing"
+check-dist = "python -m twine check dist/*"
+
+[tool.hatch.envs.test]
+features = ["test"]
+python = "3.12"
+
+[tool.hatch.envs.test.scripts]
+run = "pytest"
+
+[tool.pytest.ini_options]
+minversion = "7.0"
+addopts = "-ra -q --strict-markers"
+testpaths = ["tests"]
+pythonpath = ["src"]
+
+[tool.coverage.run]
+source_pkgs = ["geoh5vista", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/geoh5vista/__about__.py",
+]
+
+[tool.coverage.paths]
+geoh5vista = ["src/geoh5vista", "*/geoh5vista/src/geoh5vista"]
+tests = ["tests", "*/geoh5vista/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]
+
+[tool.isort]
+profile = "ruff"
+line_length = 100
+force_sort_within_sections = true
+combine_as_imports = true

geoh5vista-0.2/src/geoh5vista/__init__.py

@@ -0,0 +1,19 @@
+"""``geoh5vista``: 3D visualization and geometry processing for Geoh5 format (geoh5) objects.
+"""
+
+from importlib.metadata import PackageNotFoundError, version
+from .wrapper import geoh5wrap, read_geoh5, vtkwrap, write_geoh5
+
+try:
+    __version__ = version("geoh5vista")
+except PackageNotFoundError:
+    # Fallback for non-installed, source-only execution contexts.
+    __version__ = "unknown"
+
+
+__all__ = (
+    "geoh5wrap",
+    "read_geoh5",
+    "vtkwrap",
+    "write_geoh5"
+)