A Python package for visualizing geophysical data in VTK and ParaView. Learn more about the project here: http://demo.pvgeo.org, view examples here: http://pvgeo.org, and find all documentation here: http://docs.pvgeo.org

README.md

The PVGeo python package contains VTK powered tools for data visualization in geophysics which are wrapped for direct use within the application ParaView by Kitware. These tools are tailored to data visualization in the geosciences with a heavy focus on structured data sets like 2D or 3D time-varying grids.

Learn More: Vimeo Website Build Documentation Status Slack Badge Twitter Follow

Status: PyPI Build Status AppVeyor

Metrics: GitHub contributors Codacy Badge codecov

Demonstrations of PVGeo

For a quick overview of how PVGeo can be used in a Python environment or directly within ParaView, please checkout the code snippets and videos on the About Examples Page

Also, check out the demo page for a synopsis of the project and some visualization examples. Then check out the rest of the full website to explore the technical aspects of the project and to find use examples.

Report Issues and Contribute

Please feel free to post features you would like to see from this package on the issues page as a feature request. If you stumble across any bugs or crashes while using code distributed here, please report it in the issues section so we can promptly address it. For other questions please join the PVGeo community on Slack.

About the Authors Open Source

The PVGeo code library is managed by Bane Sullivan, graduate student in the Hydrological Science and Engineering interdisciplinary program at the Colorado School of Mines under Whitney Trainor-Guitton. If you would like to contact us, please inquire with info@pvgeo.org.

It is important to note the project is open source and that many features in this repository were made possible by contributors volunteering their time. Please take a look at the Contributors Page to learn more about the developers of PVGeo.

Getting Started

To begin using the PVGeo python package, create a new Python virtual environment and install PVGeo through pip.

# Please use Python 2.7
$ conda create -n PVGeoEnv27 python=2.7

$ conda activate PVGeoEnv27
(PVGeoEnv27) $ pip install PVGeo

Non-Windows users: Now you must install VTK to your virtual environment. For Linux and Mac users, simply install VTK through pip:

# Now install VTK
(PVGeoEnv27) $ pip install vtk

Windows Users

PVGeo on Windows can be quite (VERY) tricky to setup, so please reference previous issues with the installation label and join the PVGeo community on Slack for guidance.

Please proceed with the full instructions on the Getting Started page.

Linking PVGeo to ParaView

Now PVGeo is ready for use in your standard Python environment (non-Windows) and ready for use in PVGeo (All ). To use the PVGeo library as plugins in ParaView, please see the detailed explanation here.