Skip to content
3D plotting and mesh analysis through a streamlined interface for the Visualization Toolkit (VTK)
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs [TESTING] Replace AppVeyor with Azure (#317) Jul 19, 2019
examples Opacity by scalar array or custom transfer function (#297) Jul 11, 2019
joss Fix JOSS Figure Issues (#224) May 17, 2019
notebooks MAJOR: reorganize internal modules and implement volume rendering (#272) Jun 30, 2019
pyvista Bump version: 0.21.1 → 0.21.2 Jul 20, 2019
tests Update tests Jul 19, 2019
.codeclimate.yml Add codeclimate Jul 3, 2019
.gitattributes Update .gitattributes Dec 21, 2018
.gitignore Restructure documentation navigation bar May 15, 2019
.travis.yml Attempt fix for #215 May 24, 2019
AUTHORS.rst Add Guillaume Favelier to AUTHORS.rst (#262) Jun 14, 2019
CITATION.rst Update bibtex citation May 22, 2019
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md May 15, 2019
CONTRIBUTING.md Update contributors guidelines Jun 22, 2019
LICENSE vista → PyVista (#212) May 11, 2019
MANIFEST.in now returning image when plotting offscreen Jun 22, 2018
README.rst [TESTING] Replace AppVeyor with Azure (#317) Jul 19, 2019
azure-pipelines.yml [TESTING] Replace AppVeyor with Azure (#317) Jul 19, 2019
codecov.yml Update codecov behavior on PRs Jun 27, 2019
github_deploy_key_pyvista_pyvista.enc Fix doctr deployment May 11, 2019
pytest.ini added pyqt integration Jan 7, 2019
requirements.txt MAJOR: reorganize internal modules and implement volume rendering (#272) Jun 30, 2019
requirements_docs.txt Opacity by scalar array or custom transfer function (#297) Jul 11, 2019
setup.cfg initial commit May 31, 2017
setup.py Use io.open for encoding issues Jul 8, 2019

README.rst

PyVista

🚨🚨 PyVista was formerly vtki 🚨🚨 We recently had to change the name of this software and we apologize for any confusion this may be causing

pyvista

Deployment pypi conda
Build Status travis azure
Metrics codacy codecov
Citation joss zenodo

PyVista is a helper module for the Visualization Toolkit (VTK) that takes a different approach on interfacing with VTK through NumPy and direct array access. This package provides a Pythonic, well-documented interface exposing VTK's powerful visualization backend to facilitate rapid prototyping, analysis, and visual integration of spatially referenced datasets.

This module can be used for scientific plotting for presentations and research papers as well as a supporting module for other mesh 3D rendering dependent Python modules; see Connections for a list of projects that leverage PyVista.

Highlights

Head over to the Quick Examples page in the docs to explore our gallery of examples showcasing what PyVista can do! Want to test-drive PyVista? All of the examples from the gallery are live on MyBinder for you to test drive without installing anything locally: Launch on Binder

Overview of Features

  • Embeddable rendering in Jupyter Notebooks
  • Filtering/plotting tools built for interactivity in Jupyter notebooks (see IPython Tools)
  • Direct access to mesh analysis and transformation routines (see Filters)
  • Intuitive plotting routines with matplotlib similar syntax (see Plotting)
  • Import meshes from many common formats (use pyvista.read())
  • Export meshes as VTK, STL, OBJ, or PLY file types

Documentation

Refer to the documentation for detailed installation and usage details.

For general questions about the project, its applications, or about software usage, please create an issue in the pyvista/pyvista-support repository where the community can collectively address your questions. You are also welcome to join us on join us on Slack or send one of the developers an email. The project support team can be reached at info@pyvista.org.

Installation

PyVista can be installed from PyPI using pip on Python >= 3.5:

pip install pyvista

You can also visit PyPi, Anaconda, or GitHub to download the source.

See the Installation for more details if the installation through pip doesn't work out.

Connections

PyVista is a powerful tool that researchers can harness to create compelling, integrated visualizations of large datasets in an intuitive, Pythonic manner. Here are a few open-source projects that leverage PyVista:

  • pyansys: Pythonic interface to ANSYS result, full, and archive files
  • PVGeo: Python package of VTK-based algorithms to analyze geoscientific data and models. PyVista is used to make the inputs and outputs of PVGeo's algorithms more accessible.
  • omfvista: 3D visualization for the Open Mining Format (omf). PyVista provides the foundation for this library's visualization.
  • discretize: Discretization tools for finite volume and inverse problems. discretize provides toVTK methods that return PyVista versions of their data types for creating compelling visualizations.
  • pymeshfix: Python/Cython wrapper of Marco Attene's wonderful, award-winning MeshFix software.
  • tetgen: Python Interface to Hang Si's C++ TetGen Library

Authors

Please take a look at the contributors page and the active list of authors to learn more about the developers of PyVista.

Contributing

We absolutely welcome contributions and we hope that our Contributing Guide will facilitate your ability to make PyVista better. PyVista is mostly maintained on a volunteer basis and thus we need to foster a community that can support user questions and develop new features to make this software a useful tool for all users while encouraging every member of the commutinity to share their ideas. To learn more about contributing to PyVista, please see the Contributing Guide and our Code of Conduct.

Citing PyVista

There is a paper about PyVista!

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

Sullivan et al., (2019). PyVista: 3D plotting and mesh analysis through a streamlined interface for the Visualization Toolkit (VTK). Journal of Open Source Software, 4(37), 1450, https://doi.org/10.21105/joss.01450

BibTex:

@article{sullivan2019pyvista,
  doi = {10.21105/joss.01450},
  url = {https://doi.org/10.21105/joss.01450},
  year = {2019},
  month = {may},
  publisher = {The Open Journal},
  volume = {4},
  number = {37},
  pages = {1450},
  author = {C. Bane Sullivan and Alexander Kaszynski},
  title = {{PyVista}: 3D plotting and mesh analysis through a streamlined interface for the Visualization Toolkit ({VTK})},
  journal = {Journal of Open Source Software}
}
You can’t perform that action at this time.