Welcome to PVGeo’s code docs!¶
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.
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.
- Base Classes
- Version Verifier
- Internal Helpers
- General Filters
- Math Operations
- Table Operations
- Point/Line Sets
- Grid Tools
- GSLib & SGeMS
- Model Builder
- General Readers
- UBC Mesh Tools
- General Tools
- OcTree Mesh
- Tensor Mesh
- Base Classes