https://github.com/opengeovis/omfvista
3D visualization for the Open Mining Format (omf)
https://github.com/opengeovis/omfvista
Last synced: 9 months ago
JSON representation
3D visualization for the Open Mining Format (omf)
- Host: GitHub
- URL: https://github.com/opengeovis/omfvista
- Owner: OpenGeoVis
- License: bsd-3-clause
- Created: 2019-01-09T20:44:53.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-07-04T17:42:55.000Z (12 months ago)
- Last Synced: 2025-09-28T06:38:34.931Z (9 months ago)
- Language: Python
- Homepage: https://opengeovis.github.io/omfvista/
- Size: 122 MB
- Stars: 63
- Watchers: 7
- Forks: 18
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
Open Mining Format: PyVista (VTK) Interface
===========================================
.. image:: https://img.shields.io/pypi/v/omfvista.svg?logo=python&logoColor=white
:target: https://pypi.org/project/omfvista/
:alt: PyPI
.. image:: https://codecov.io/gh/OpenGeoVis/omfvista/branch/master/graph/badge.svg
:target: https://codecov.io/gh/OpenGeoVis/omfvista
.. image:: https://img.shields.io/github/stars/OpenGeoVis/omfvista.svg?style=social&label=Stars
:target: https://github.com/OpenGeoVis/omfvista
:alt: GitHub
A PyVista (and VTK) interface for the `Open Mining Format package`_ (``omf``)
providing Python 3D visualization and useable mesh data structures for
processing datasets in the OMF specification.
.. _Open Mining Format package: https://omf.readthedocs.io/en/latest/
Documentation is hosted at https://opengeovis.github.io/omfvista/
Check out the `Example Notebook`_ on NBViewer! Or
`launch the Notebook on MyBinder`_ to run the code yourself!
.. _Example Notebook: https://nbviewer.jupyter.org/github/OpenGeoVis/omfvista/blob/master/Example.ipynb
.. _launch the Notebook on MyBinder: https://mybinder.org/v2/gh/OpenGeoVis/omfvista/master?filepath=Example.ipynb
.. image:: https://github.com/OpenGeoVis/omfvista/raw/master/assets/scene.png
:alt: Integrated Scene
Installation
------------
Installation is simply::
pip install omfvista
All necessary dependencies will be installed alongside ``omfvista``. Please
note that this package heavily leverages the PyVista_ package.
.. _PyVista: https://github.com/pyvista/pyvista
Questions & Support
-------------------
For general questions about the project, its applications, or about software
usage, please create an issue in the `pyvista/pyvista-support`_ repository
where the PyVista community can collectively address your questions.
You are also welcome to join us on join `@OpenGeoVis`_ on our
`Slack workspace`_ under the ``#omfvista`` channel or send one of the
developers an email. The project support team can be reached at
`info@opengeovis.org`_.
.. _pyvista/pyvista-support: https://github.com/pyvista/pyvista-support
.. _@OpenGeoVis: https://github.com/OpenGeoVis
.. _Slack workspace: http://slack.opengeovis.org
.. _info@opengeovis.org: mailto:info@opengeovis.org
Example Use
-----------
.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/OpenGeoVis/omfvista/master?filepath=Example.ipynb
Be sure to check out the `Example Notebook`_ that demos ``omfvista`` or our
`Example Gallery`_ in the documentation!
Here's an example using the sample data hosted in the `OMF repository`_.
.. _Example Gallery: https://opengeovis.github.io/omfvista/examples/index.html
.. _OMF repository: https://github.com/gmggroup/omf/tree/master/assets
.. code-block:: python
import pyvista as pv
import omfvista
project = omfvista.load_project('test_file.omf')
project
.. image:: https://github.com/OpenGeoVis/omfvista/raw/master/assets/table-repr.png
:alt: Table Representation
Once the data is loaded as a ``pyvista.MultiBlock`` dataset from ``omfvista``, then
that object can be directly used for interactive 3D visualization from PyVista_:
.. code-block:: python
project.plot(multi_colors=True)
An interactive scene can be created and manipulated to create a compelling
figure. First, grab the elements from the project:
.. code-block:: python
# Grab a few elements of interest and plot em up!
vol = project['Block Model']
assay = project['wolfpass_WP_assay']
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:
.. code-block:: 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(assay, color='blue', line_width=3)
p.add_mesh(dacite, color='yellow', opacity=0.6)
# Add the volumetric dataset with a thresholding tool
p.add_mesh_threshold(vol)
# Add the bounds axis
p.show_bounds()
# Redner the scene in a pop out window
p.show()
.. figure:: https://github.com/OpenGeoVis/omfvista/raw/master/assets/interactive.gif
:alt: Interactive Rendering