Repository files navigation

3D plotting and mesh analysis through a streamlined interface for the Visualization Toolkit (VTK)

PyVista is:

• Pythonic VTK: a high-level API to theVisualization Toolkit (VTK)
• mesh data structures and filtering methods for spatial datasets
• 3D plotting made simple and built for large/complex data geometries

PyVista is a helper module for the Visualization Toolkit (VTK) that wraps the VTK librarythrough NumPy and direct array access through a variety of methods and classes.This package provides a Pythonic, well-documented interface exposingVTK'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 researchpapers as well as a supporting module for other mesh 3D rendering dependentPython modules; see Connections for a list of projects that leveragePyVista.

Share this project on X:

PyVista is a NumFOCUS affiliated project

Deployment
Build Status
Metrics
Activity
Citation
License
Community
Formatter
Linter
Affiliated
Mentioned

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

• Extensive gallery of examples (seeQuick Examples)
• Interactive plotting in Jupyter Notebooks with server-side and client-siderendering withtrame.
• Filtering/plotting tools built for interactivity (seeWidgets)
• Direct access to mesh analysis and transformation routines (seeFilters)
• Intuitive plotting routines withmatplotlib similar syntax (seePlotting)
• Import meshes from many common formats (usepyvista.read()). Support for all formats handled bymeshio is built-in.
• Export meshes as VTK, STL, OBJ, or PLY (mesh.save()) file types or any formats supported bymeshio (pyvista.save_meshio())

Refer to thedocumentation for detailedinstallation and usage details.

For general questions about the project, its applications, or about softwareusage, please create a discussion inpyvista/discussionswhere the community can collectively address your questions. You are alsowelcome to join us onSlack.

PyVista can be installed fromPyPIusingpip on Python >= 3.9:

pip install pyvista

You can also visitPyPI,Anaconda, orGitHub to download the source.

See theInstallationfor more details regarding optional dependencies or if the installation through pip doesn't work out.

PyVista is a powerful tool that researchers can harness to create compelling,integrated visualizations of large datasets in an intuitive, Pythonic manner.

Learn more about how PyVista is used across science and engineering disciplinesby a diverse community of users on ourConnections page.

Please take a look at thecontributors page and the activelist of authorsto learn more about the developers of PyVista.

Made withcontrib rocks.

We absolutely welcome contributions and we hope that ourContributing Guidewill facilitate your ability to make PyVista better. PyVista is mostlymaintained on a volunteer basis and thus we need to foster a community that cansupport user questions and develop new features to make this software a usefultool for all users while encouraging every member of the community to sharetheir ideas. To learn more about contributing to PyVista, please see theContributing Guide and ourCode of Conduct.

There is apaper about PyVista.

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

Sullivan and Kaszynski, (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 = {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}}

While PyVista is an Open Source project with a big community, you might be looking for professional support.This section aims to list companies with VTK/PyVista expertise who can help you with your software project.