Skip to content

pyvista/pyvista-tutorial

Repository files navigation

3D Visualization with PyVista

Binder License: MIT

Abstract

PyVista is a general purpose 3D visualization library used for over 1400+ open source projects and many closed source projects for the visualization of everything from computer aided engineering and geophysics to volcanoes and digital artwork.

PyVista exposes a Pythonic API to the Visualization Toolkit (VTK) to provide tooling that is immediately usable without any prior knowledge of VTK and is being built as the 3D equivalent of Matplotlib, with plugins to Jupyter to enable visualization of 3D data using both server- and client-side rendering.

We will provide a hands-on tutorial accessible to anyone with internet access and a computer via many of PyVista's existing example Jupyter notebooks and new material through a comprehensive overview highlighting popular 3D visualization use cases.

Keywords

visualization meshviewer vtk 3d

Other Information and Files

See our examples at PyVista Examples

PyVista is a NumFOCUS Affiliated Project

Tutorial Description

Our tutorial will demonstrate PyVista's latest capabilities and bring a wide range of users to the forefront of 3D visualization in Python.

  • Use PyVista to create 3D visualizations from a variety of datasets in common formats.
  • Overview the classes and data structures of PyVista with real-world examples.
  • Be familiar of the various filters and features of PyVista.
  • Know which Python libraries are used and can be used by PyVista (meshio, trimesh etc).

We see this tutorial catering to anyone who wants to visualize data in any domain, and this ranges from basic Python users to advanced power users.

Tutorial Outline

  1. Getting Started (Alexander Kaszynski) - PyVista for 3D Visualization within Python. (10 min for talk, 10 min for exercise)

  2. PyVista & Jupyter (Bane Sullivan) - Demonstrate how to use PyVista in Jupyter for state-of-the-art 3D visualization in Notebooks and make sure the class room is up and running. (5 min for talk, 15 for exercise)

  3. Basic usage (Alexander Kaszynski) - Reading and plotting 3D data using examples module and external files. (10 min for talk, 10 min for exercise)

  4. What is a Mesh? (Alexander Kaszynski) - Learn the basics of the PyVista data types and how to open common 3D file formats to visualize the data in 3D (20 min for talk, 10 min for exercise)

  5. Break. Stretch fingers and grab some coffee. (15 minutes)

  6. Plotting Options and Animations (Bane Sullivan) - Demonstrate many features of the PyVista plotting API to create compelling 3D visualizations and touch on animations (15 min for talk, 20 min for exercise)

  7. Filters (Alexander Kaszynski) - Demonstrate the PyVista filters API to perform mesh analysis and alteration (15 minutes)

  8. PyVista in Action (Tetsuo Koyama) - Show how PyVista is already being used within several projects and can be used for all things visualization. (15 min for talk)

  9. Quick break. Prepare for the final run. (10 minutes)

  10. PyVista & Trame (Bane Sullivan) - Leverage PyVista and Trame to make awesome interactive web applications. (20 min for talk, 10 min for exercise)

  11. PyVista & VTK (Bane Sullivan) - Show how PyVista uses VTK and how you can combine the best of both worlds! (10 minutes for talk, 15 minutes for exercise)

  12. Open up to Questions. (15 minutes)

Additional Tutorial Information

We will base the material for the tutorial on the examples in PyVista's online documentation. Transform 2021: Guide to PyVista Tutorial will also be used as material. The tutorial itself will be in the pyvista/pyvista-tutorial repository.

Tutorial Prerequisites

We see this tutorial catering to anyone who wants to visualize data in any domain, and this ranges from basic Python users to advanced power users.

In fact, our tutorial instructors and community members come from a diverse set of backgrounds.

  1. Basic knowledge of Python to get started. Be able to install Jupyter Lab on your machine and be up and running.
  2. Intermediate users will want to be familiar with NumPy and Matplotlib and perhaps other libraries that are compatible with PyVista, like trimesh or meshio.
  3. Advanced users should be familiar with the Visualization Toolkit (VTK) and general data science.

Appropriate level of the attendees' Python knowledge

Something for everyone!

  • Beginner
  • Intermediate
  • Advanced

Instructor Bio(s)

Alex Kaszynski, co-creator of PyVista and creator of the PyAnsys organization.

Advocate for all things Python with extensive experience presenting as a speaker at IGTI conferences for the past decade, and for four years at Ansys developing PyAnsys to enable automation through Python for CAE applications.

Enjoys presenting and demoing Python, especially 3D visualization but also its application to CAE and automation.

Bane Sullivan, co-creator of PyVista, is a Research Software Engineer working at the intersection of geoscience, visualization, and data science.

Bane is a geophysicist/hydrologist by training and has been working to grow PyVista's adoption within the subsurface geoscience communities.

Interested in scientific computing and visualization with computer graphics. Developer team member of PyVista. Past experience as a speaker:

Bill Little, creator of GeoVista, is a software engineer working at the UK Met Office and a core developer on SciTools, which includes Cartopy and Iris.

Paper

DOI