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
Raw data
{
"_id": null,
"home_page": "https://github.com/OpenGeoVis/omfvista",
"name": "omfvista",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Bane Sullivan",
"author_email": "info@pvgeo.org",
"download_url": "https://files.pythonhosted.org/packages/9e/44/75588ee7cb26b15832f39cec354e660ff3b4a45d6932f6bc7b14eed081f5/omfvista-0.3.0.tar.gz",
"platform": null,
"description": "Open Mining Format: PyVista (VTK) Interface\n===========================================\n\n.. image:: https://img.shields.io/pypi/v/omfvista.svg?logo=python&logoColor=white\n :target: https://pypi.org/project/omfvista/\n :alt: PyPI\n\n.. image:: https://codecov.io/gh/OpenGeoVis/omfvista/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/OpenGeoVis/omfvista\n\n.. image:: https://img.shields.io/github/stars/OpenGeoVis/omfvista.svg?style=social&label=Stars\n :target: https://github.com/OpenGeoVis/omfvista\n :alt: GitHub\n\n\nA PyVista (and VTK) interface for the `Open Mining Format package`_ (``omf``)\nproviding Python 3D visualization and useable mesh data structures for\nprocessing datasets in the OMF specification.\n\n\n.. _Open Mining Format package: https://omf.readthedocs.io/en/latest/\n\nDocumentation is hosted at https://opengeovis.github.io/omfvista/\n\nCheck out the `Example Notebook`_ on NBViewer! Or\n`launch the Notebook on MyBinder`_ to run the code yourself!\n\n.. _Example Notebook: https://nbviewer.jupyter.org/github/OpenGeoVis/omfvista/blob/master/Example.ipynb\n.. _launch the Notebook on MyBinder: https://mybinder.org/v2/gh/OpenGeoVis/omfvista/master?filepath=Example.ipynb\n\n.. image:: https://github.com/OpenGeoVis/omfvista/raw/master/assets/scene.png\n :alt: Integrated Scene\n\nInstallation\n------------\n\nInstallation is simply::\n\n pip install omfvista\n\nAll necessary dependencies will be installed alongside ``omfvista``. Please\nnote that this package heavily leverages the PyVista_ package.\n\n.. _PyVista: https://github.com/pyvista/pyvista\n\n\nQuestions & Support\n-------------------\n\nFor general questions about the project, its applications, or about software\nusage, please create an issue in the `pyvista/pyvista-support`_ repository\nwhere the PyVista community can collectively address your questions.\nYou are also welcome to join us on join `@OpenGeoVis`_ on our\n`Slack workspace`_ under the ``#omfvista`` channel or send one of the\ndevelopers an email. The project support team can be reached at\n`info@opengeovis.org`_.\n\n.. _pyvista/pyvista-support: https://github.com/pyvista/pyvista-support\n.. _@OpenGeoVis: https://github.com/OpenGeoVis\n.. _Slack workspace: http://slack.opengeovis.org\n.. _info@opengeovis.org: mailto:info@opengeovis.org\n\nExample Use\n-----------\n\n.. image:: https://mybinder.org/badge_logo.svg\n :target: https://mybinder.org/v2/gh/OpenGeoVis/omfvista/master?filepath=Example.ipynb\n\nBe sure to check out the `Example Notebook`_ that demos ``omfvista`` or our\n`Example Gallery`_ in the documentation!\nHere's an example using the sample data hosted in the `OMF repository`_.\n\n.. _Example Gallery: https://opengeovis.github.io/omfvista/examples/index.html\n.. _OMF repository: https://github.com/gmggroup/omf/tree/master/assets\n\n.. code-block:: python\n\n import pyvista as pv\n import omfvista\n\n project = omfvista.load_project('test_file.omf')\n project\n\n.. image:: https://github.com/OpenGeoVis/omfvista/raw/master/assets/table-repr.png\n :alt: Table Representation\n\n\nOnce the data is loaded as a ``pyvista.MultiBlock`` dataset from ``omfvista``, then\nthat object can be directly used for interactive 3D visualization from PyVista_:\n\n.. code-block:: python\n\n project.plot(multi_colors=True)\n\nAn interactive scene can be created and manipulated to create a compelling\nfigure. First, grab the elements from the project:\n\n.. code-block:: python\n\n # Grab a few elements of interest and plot em up!\n vol = project['Block Model']\n assay = project['wolfpass_WP_assay']\n topo = project['Topography']\n dacite = project['Dacite']\n\nThen create a 3D scene with these spatial data and apply a filtering tool from\nPyVista_ to the volumetric data:\n\n.. code-block:: python\n\n # Create a plotting window\n p = pv.Plotter(notebook=False)\n # Add our datasets\n p.add_mesh(topo, cmap='gist_earth', opacity=0.5)\n p.add_mesh(assay, color='blue', line_width=3)\n p.add_mesh(dacite, color='yellow', opacity=0.6)\n # Add the volumetric dataset with a thresholding tool\n p.add_mesh_threshold(vol)\n # Add the bounds axis\n p.show_bounds()\n # Redner the scene in a pop out window\n p.show()\n\n\n.. figure:: https://github.com/OpenGeoVis/omfvista/raw/master/assets/interactive.gif\n :alt: Interactive Rendering\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "3D visualization for the Open Mining Format (omf)",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/OpenGeoVis/omfvista"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1a41ca7946daa97387e9d0ad17ac4c00cd21885c4e1f545400d47866c7a70b77",
"md5": "e1c05ee4c333ad6660629f6367b38b8b",
"sha256": "310b793b9fb9854ae6a316577cec5c1948c430dca5c79c072429d40308e34f30"
},
"downloads": -1,
"filename": "omfvista-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e1c05ee4c333ad6660629f6367b38b8b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 13564,
"upload_time": "2023-10-17T05:51:42",
"upload_time_iso_8601": "2023-10-17T05:51:42.198380Z",
"url": "https://files.pythonhosted.org/packages/1a/41/ca7946daa97387e9d0ad17ac4c00cd21885c4e1f545400d47866c7a70b77/omfvista-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9e4475588ee7cb26b15832f39cec354e660ff3b4a45d6932f6bc7b14eed081f5",
"md5": "9c715fb7bdecb7878aa248404bd6f759",
"sha256": "d462a6d3cd1b128db28357236c5064d9f0ff411a97b219be6c13c8dc4d4c7f2c"
},
"downloads": -1,
"filename": "omfvista-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "9c715fb7bdecb7878aa248404bd6f759",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12500,
"upload_time": "2023-10-17T05:51:43",
"upload_time_iso_8601": "2023-10-17T05:51:43.757629Z",
"url": "https://files.pythonhosted.org/packages/9e/44/75588ee7cb26b15832f39cec354e660ff3b4a45d6932f6bc7b14eed081f5/omfvista-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-17 05:51:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenGeoVis",
"github_project": "omfvista",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "omfvista"
}
JSON
