Welcome to PVGeo’s code docs!

Vimeo Website PyPI Codacy Badge Slack Build Status Code Coverage GitHub Contributors Documentation Built by gendocs

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.

This website hosts the code documentation for the PVGeo python package found on GitHub and PyPI. This website strictly documents the code so that users have a convenient and familiar means of searching through the library to understand the backend of the features they are using. If you are searching for examples and demonstrations on how to use the PVGeo library, then head over to the full website where you can find tutorials with sample data sets and links to many other helpful resources.

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.

Requesting Features, Reporting Issues, and Contributing

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 page so we can promptly address it. For other questions please join the PVGeo community on Slack.

About the Authors

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 virtual environment and install PVGeo through pip.

$ conda create -n PVGeoEnv27 python=2.7

# Activate the virtual environment
$ conda activate PVGeoEnv27

# Install PVGeo
(PVGeoEnv27) $ pip install PVGeo

# Now install VTK>=8.1.0
(PVGeoEnv27) $ pip install vtk


Windows users: Please see installation instructions on GitHub README.

Now PVGeo is ready for use in your standard python environment. To use the PVGeo library as plugins in ParaView, please see the detailed explanation here.

Current Statistics

base filter macro reader source writer
10 33 8 15 5 6