Welcome to PVGeo’s code docs!

http://joss.theoj.org/papers/10.21105/joss.01451/status.svg 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 or directly in a Python >=3.6 environment when paired with the PyVista Python package. 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 documentation for the PVGeo Python package found on GitHub and PyPI.

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.

Connections

This package provides many VTK-like algorithms designed for geoscientific data formats and types to perform data integration and analysis. To ensure our users have powerful and easy to use tools that can visualize the results of PVGeo algorithms, we are actively involved in the development of PyVista: a toolset for easy access to VTK data objects and 3D visualization in Python. To learn more about pairing PVGeo with PyVista, please check out the example Jupyter notebooks.

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 was created and 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.

Citing PVGeo

http://joss.theoj.org/papers/10.21105/joss.01451/status.svg

There is a paper about PVGeo!

If you are using PVGeo in your scientific research, please help our scientific visibility by citing our work!

Sullivan et al., (2019). PVGeo: an open-source Python package for geoscientific visualization in VTK and ParaView. Journal of Open Source Software, 4(38), 1451, https://doi.org/10.21105/joss.01451

BibTex:

@article{sullivan2019pvgeo,
  doi = {10.21105/joss.01451},
  url = {https://doi.org/10.21105/joss.01451},
  year = {2019},
  month = {Jun},
  publisher = {The Open Journal},
  volume = {4},
  number = {38},
  pages = {1451},
  author = {C. Bane Sullivan and Whitney J. Trainor-Guitton},
  title = {{PVGeo}: an open-source Python package for geoscientific visualization in {VTK} and {ParaView}},
  journal = {Journal of Open Source Software}
}

Getting Started

To begin using the PVGeo Python package, create/activate your Python virtual environment (we highly recommend using anaconda) and install PVGeo through pip:

pip install PVGeo

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

12

33

8

17

5

6