Skip to main content

Easier Pythonic interface to VTK

Project description

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

pyvista

PyVista is:

  • Pythonic VTK: a high-level API to the Visualization Toolkit (VTK)

  • mesh data structures and filtering methods for spatial datasets

  • 3D plotting made simple and built for large/complex data geometries

pyvista ipython demo

PyVista is a helper module for the Visualization Toolkit (VTK) that wraps the VTK library through NumPy and direct array access through a variety of methods and classes. 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.

PyVista is a NumFOCUS affiliated project

NumFOCUS affiliated projects

Status badges

Deployment

pypi Python versions conda nix Packaging status

Build Status

GH-CI python pre-commit.ci status

Metrics

codacy codecov

Activity

PyPIact condaact

Citation

joss zenodo

License

MIT

Community

slack discuss Good first issue GitHub Repo stars

Formatter

prettier

Linter

Ruff

Affiliated

NumFOCUS Affiliated

Mentioned

Awesome Scientific Computing

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

  • Extensive gallery of examples (see Quick Examples)

  • Interactive plotting in Jupyter Notebooks with server-side and client-side rendering with trame.

  • Filtering/plotting tools built for interactivity (see Widgets)

  • 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()). Support for all formats handled by meshio is built-in.

  • Export meshes as VTK, STL, OBJ, or PLY (mesh.save()) file types or any formats supported by meshio (pyvista.save_meshio())

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 a discussion in pyvista/discussions where the community can collectively address your questions. You are also welcome to join us on Slack.

Installation

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

pip install pyvista

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

See the Installation for more details regarding optional dependencies or 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.

Learn more about how PyVista is used across science and engineering disciplines by a diverse community of users on our Connections page.

Authors

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

contrib.rocks

Made with contrib rocks.

Contributing

Contributor Covenant Code Triage Open in GitHub Codespaces

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

Professional Support

PyVista is a community-driven Open Source project, but many users and organizations rely on it in production workflows, research pipelines, and custom visualization systems. If you need expert guidance, development help, or guaranteed support, there are several ways to engage with the people who build and maintain PyVista.

For general inquiries, reach out to info@pyvista.org and we can help connect you with the right community experts for your 3D visualization or analysis needs.

If you are looking for professional services (consulting, custom development, feature design, integration support, or training), consider sponsoring PyVista’s core developers through the “Sponsor this project” section on GitHub. Sponsorship not only provides direct access to experts but also helps sustain critical maintenance and ongoing feature work that keeps PyVista reliable and modern.

More details can be found in the discussion post: https://github.com/pyvista/pyvista/discussions/4033

Sponsoring a developer supports both your project and the health of the PyVista ecosystem, ensuring continued improvements, long-term stability, and expert help when you need it.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyvista-0.48.0.tar.gz (2.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyvista-0.48.0-py3-none-any.whl (2.6 MB view details)

Uploaded Python 3

File details

Details for the file pyvista-0.48.0.tar.gz.

File metadata

  • Download URL: pyvista-0.48.0.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for pyvista-0.48.0.tar.gz
Algorithm Hash digest
SHA256 317c1590fce0d3777c34d7c2b4686dc52701a2ba03ab0a312bbd0bdae03f0d42
MD5 3fea830128b9488fd41b4dc2b551d896
BLAKE2b-256 8024a8bf4deb6521d4a26bdfe1262e2e942aaf49b866f8dc8395702d789e5089

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyvista-0.48.0.tar.gz:

Publisher: testing-and-deployment.yml on pyvista/pyvista

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyvista-0.48.0-py3-none-any.whl.

File metadata

  • Download URL: pyvista-0.48.0-py3-none-any.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for pyvista-0.48.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cb6fe80d4a1a7e9ef512b9b555d8b16355ea97b07799fc4f73f2897ca0109e09
MD5 27121a35a2aa81ebcdc486c8d254e34a
BLAKE2b-256 a5e8d057b011aee8df7fdb00e5e8f777cea160f2e97f65796bff7c81b85e398d

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyvista-0.48.0-py3-none-any.whl:

Publisher: testing-and-deployment.yml on pyvista/pyvista

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page