u-anurag / pvgeo

Python package of VTK-based algorithms to analyze geoscientific data and models

Share this project:

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 in a Python environment with PyVista. 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:

Status:

Metrics:

Demonstrations of PVGeo

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

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.

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 (2.7 or >=3.6) with all dependencies installed! Go ahead and test your install:

python -c "import PVGeo; print(PVGeo.__version__)"

Note that Windows users must use Python >=3.6 when outside of ParaView. Further insight can be found in the Getting Started Guide.

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, report them in the issues section so we can promptly address it. For other questions, join the PVGeo community on Slack.

Interested in contributing to PVGeo? Please see the contributing guide

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, inquire with [email protected].

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. Head over to the Contributors Page to learn more about the developers of PVGeo.

Citing PVGeo

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

See CITATION.rst for more details.

Linking PVGeo to ParaView

To use the PVGeo library as plugins in ParaView, please see the detailed explanation here where you must create a second isolated Python 2.7 environment that will host PVGeo for ParaView.