PVGeo

PVGeo: an open-source Python package for geoscientific visualization in VTK and ParaView - Published in JOSS (2019)

https://github.com/opengeovis/pvgeo

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 8 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    1 of 7 committers (14.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

3d data-visualization geophysics geosciences model-building open-science paraview paraview-plugin python visual-data-integration visualization vtk

Keywords from Contributors

fem finite-element-analysis finite-elements mesh mesh-processing meshviewer networkx
Last synced: 4 months ago · JSON representation ·

Repository

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

Basic Info
  • Host: GitHub
  • Owner: OpenGeoVis
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Homepage: https://pvgeo.org
  • Size: 503 MB
Statistics
  • Stars: 223
  • Watchers: 16
  • Forks: 43
  • Open Issues: 8
  • Releases: 18
Topics
3d data-visualization geophysics geosciences model-building open-science paraview paraview-plugin python visual-data-integration visualization vtk
Created over 8 years ago · Last pushed 11 months ago
Metadata Files
Readme License Citation

README.md

The PVGeo Python package contains VTK powered tools for data visualization in geophysics which are wrapped for direct use 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: DOI Vimeo Slack Badge

Status: PyPI Testing

Metrics: GitHub contributors codecov

Demonstrations of PVGeo

For a quick overview of how PVGeo can be used, 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:

bash pip install PVGeo

Now PVGeo is ready for use in your standard Python environment (>=3.9) with all dependencies installed! Go ahead and test your install:

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

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 Open Source

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 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. 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

While PVGeo was previously design to be used as plugins directly in ParaView, we are unable to maintain support for ParaView and recommend using PyVista instead.

Owner

  • Name: OpenGeoVis: open-source geovisualization tools
  • Login: OpenGeoVis
  • Kind: organization
  • Email: info@opengeovis.org

Creating open-source tools for geoscientific visualization and analysis

JOSS Publication

PVGeo: an open-source Python package for geoscientific visualization in VTK and ParaView
Published
June 30, 2019
Volume 4, Issue 38, Page 1451
Authors
C. Bane Sullivan ORCID
Department of Geophysics, Colorado School of Mines, Golden, CO, USA
Whitney J. Trainor-Guitton ORCID
Department of Geophysics, Colorado School of Mines, Golden, CO, USA
Editor
Leonardo Uieda ORCID
Tags
visualization 3D geoscience

Citation (CITATION.rst)

.. _citation_ref:

Citing PVGeo
------------

.. image:: http://joss.theoj.org/papers/10.21105/joss.01451/status.svg
   :target: https://doi.org/10.21105/joss.01451

There is a `paper about PVGeo <https://doi.org/10.21105/joss.01451>`_!

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:

.. code::

    @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}
    }

GitHub Events

Total
  • Issues event: 1
  • Watch event: 12
  • Push event: 7
  • Pull request event: 2
  • Fork event: 2
  • Create event: 1
Last Year
  • Issues event: 1
  • Watch event: 12
  • Push event: 7
  • Pull request event: 2
  • Fork event: 2
  • Create event: 1

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 1,730
  • Total Committers: 7
  • Avg Commits per committer: 247.143
  • Development Distribution Score (DDS): 0.019
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Bane Sullivan c****i@m****u 1,697
RichardScottOZ 7****Z 26
Leonardo Uieda l****a@g****m 3
The Codacy Badger b****r@c****m 1
Tetsuo Koyama t****0@g****m 1
Kyle Niemeyer k****r@g****m 1
GudniRos g****n@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 46
  • Total pull requests: 64
  • Average time to close issues: 9 months
  • Average time to close pull requests: 3 months
  • Total issue authors: 27
  • Total pull request authors: 6
  • Average comments per issue: 3.28
  • Average comments per pull request: 0.16
  • Merged pull requests: 61
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 2
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Issue authors: 2
  • Pull request authors: 1
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • banesullivan (16)
  • leminhson (4)
  • craigmillernz (2)
  • RichardScottOZ (1)
  • ghost (1)
  • Geoscientist1 (1)
  • leouieda (1)
  • huyquangtranaus (1)
  • jacobgrasmick (1)
  • andrea-bistacchi (1)
  • Gloomy87 (1)
  • FrankForster (1)
  • ZiXuanWan1994 (1)
  • Coastal0 (1)
  • Leguark (1)
Pull Request Authors
  • banesullivan (35)
  • RichardScottOZ (26)
  • leouieda (3)
  • dependabot[bot] (2)
  • kyleniemeyer (1)
  • tkoyama010 (1)
Top Labels
Issue Labels
Feature Request (11) help wanted (6) installation (5) bug (3) Low Hanging Fruit (3) JOSS (3) community (2) question (2) PyVista (2) hacktoberfest (2) incomplete (2) ParaView (1) examples (1) docs (1)
Pull Request Labels
JOSS (4) hacktoberfest (2) dependencies (2) incomplete (1) docs (1)

Packages

  • Total packages: 3
  • Total downloads:
    • pypi 411 last-month
  • Total dependent packages: 1
    (may contain duplicates)
  • Total dependent repositories: 6
    (may contain duplicates)
  • Total versions: 218
  • Total maintainers: 2
proxy.golang.org: github.com/opengeovis/pvgeo
  • Versions: 80
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 4 months ago
proxy.golang.org: github.com/OpenGeoVis/PVGeo
  • Versions: 80
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 4 months ago
pypi.org: pvgeo

Geoscientific visualization tools for PyVista

  • Versions: 58
  • Dependent Packages: 1
  • Dependent Repositories: 6
  • Downloads: 411 Last month
Rankings
Stargazers count: 5.0%
Dependent repos count: 6.1%
Forks count: 6.3%
Dependent packages count: 7.3%
Average: 8.3%
Downloads: 16.9%
Maintainers (2)
Last synced: 4 months ago