pyvista

(★ 3,776)

3D visualization and mesh analysis for science and engineering

File Explorer

Download Latest Version (.zip)

Showing a partial file list — download the zip above to see everything.

- - devcontainer.json
  - oncreatecommand.sh
- devcontainer.json
- oncreatecommand.sh
- - ideas.yml
  - q-a.yml
  - show-and-tell.yml
- - bug-report.yml
  - config.yml
  - feature-request.yml
  - maintenance-request.yml
- - context7.json
- - cache-pyvista-data.yml
  - dependency-conflicts.yml
  - docker-package.yml
  - docs.yml
  - integration-tests.yml
  - intersphinx-update-pull-request.yml
  - label.yml
  - linkcheck.yml
  - netlify-deploy.yml
  - python-syntax.yml
  - style-docstring.yml
  - testing-and-deployment.yml
  - type-checking.yml
  - validate-makefile.yml
  - vtk-master-wheels.yml
- auto-merge.yml
- CODEOWNERS
- copilot-instructions.md
- dependabot.yml
- labeler.yml
- PULL_REQUEST_TEMPLATE.md
- release.yml
- RUNNERS.md
- zizmor.yml
- pyvista_ipython_demo.gif
- - imageio-objects.inv
  - matplotlib-objects.inv
  - numpy-objects.inv
  - pandas-objects.inv
  - pyarrow-objects.inv
  - pytest-objects.inv
  - python-objects.inv
  - pyvistaqt-objects.inv
  - scipy-objects.inv
  - trimesh-objects.inv
  - update.sh
- - conf.py
  - contributing.rst
  - index.rst
  - make_external_gallery.py
  - make_tables.py
  - pyvista-binder-config.yml
- - .gitignore
- .vale.ini
- make_dev_wheel.py
- Makefile
- dev-gitpod.Dockerfile
- Dockerfile
- README.md
- - create_circular_arc.py
  - create_draped_surface.py
  - create_explicit_structured_grid.py
  - create_geometric_objects.py
  - create_kochanek_spline.py
  - create_multiple_lines.py
  - create_parametric_geometric_objects.py
  - create_pixel_art.py
  - create_platonic_solids.py
  - create_point_cloud.py
  - create_pointset.py
  - create_poly.py
  - create_polydata_strips.py
  - create_polyhedron.py
  - create_sphere.py
  - create_spline.py
  - create_structured_surface.py
  - create_text_3d.py
  - create_tri_surface.py
  - create_truss.py
  - create_uniform_grid.py
  - create_unstructured_surface.py
  - linear_cells.py
  - load_gltf.py
  - load_vrml.py
  - read_dolfin.py
  - read_file.py
  - read_image.py
  - read_parallel.py
  - reader.py
  - README.rst
  - terrain_following_mesh.py
  - wrap_trimesh.py
- - boolean_operations.py
  - cell_centers.py
  - clip_closed_surface.py
  - clip_with_plane_box.py
  - clip_with_surface.py
  - collision.py
  - compare_threshold_filters.py
  - compute_normals.py
  - connectivity.py
  - contouring.py
  - convex_hull.py
  - crop_labeled.py
  - decimate.py
  - distance_between_surfaces.py
  - extract_cells_inside_surface.py
  - extract_edges.py
  - extract_surface.py
  - extrude_rotate.py
  - extrude_trim.py
  - farthest_point_sampling.py
  - fill_holes.py
  - gaussian_smoothing.py
  - geodesic.py
  - glyph.py
  - glyph_table.py
  - gradients.py
  - icp_registration.py
  - image_fft.py
  - image_fft_perlin_noise.py
  - image_representations.py
  - integrate_data.py
  - interpolate.py
  - interpolate_sample.py
  - marching_cubes.py
  - mesh_quality.py
  - perlin_noise_2d.py
  - perlin_noise_3d.py
  - point_cloud_distance.py
  - point_cloud_orientation.py
  - project_plane.py
  - ray_trace.py
  - README.rst
  - reflect.py
  - resampling.py
  - rotate.py
  - slice.py
  - streamlines.py
  - streamlines_2D.py
  - subdivide.py
  - surface_reconstruction.py
  - surface_smoothing.py
  - using_filters.py
  - volumetric_analysis.py
  - voxelize.py
  - warp_by_vector.py
- - anti_aliasing.py
  - axes_objects.py
  - backface_prop.py
  - background_image.py
  - blurring.py
  - bounds.py
  - chart_basics.py
  - chart_overlays.py
  - chemistry_molecule.py
  - clear.py
  - color_cycler.py
  - color_lines.py
  - colormap.py
  - composite_picking.py
  - depth_of_field.py
  - depth_peeling.py
  - distance_along_spline.py
  - distance_measurement.py
  - edl.py
  - element_picking.py
  - flight_paths.py
  - floors.py
  - ghost_cells.py
  - gif.py
  - graph_network.py
  - image_depth.py
  - interpolate_before_map.py
  - legend.py
  - lighting_mesh.py
  - linked_views.py
  - logo.py.old
  - lookup_table.py
  - lorenz_attractor.py
  - maximum_intensity_projection.py
  - mesh_picking.py
  - movie.py
  - movie_glyphs.py
  - moving_cmap.py
  - moving_isovalue.py
  - multi_window.py
  - opacity.py
  - orbit.py
  - pbr.py
  - plot_over_circular_arc.py
  - plot_over_line.py
  - point_cell_scalars.py
  - point_cloud_neighbors.py
  - point_clouds.py
  - point_labels.py
  - point_picking.py
  - point_sprites.py
  - points_gaussian_scale.py
  - README.rst
  - scalar_bar.py
  - screenshot.py
  - shading.py
  - sharing_scalar_bars.py
  - show_edges.py
  - silhouette.py
  - slice_orthogonal.py
  - spherical.py
  - ssao.py
  - surface_point_picking.py
  - texture.py
  - themes.py
  - topo_map.py
  - vector_component.py
  - vertices.py
  - volume_rendering.py
- - animation.py
  - box_widget.py
  - checkbox_widget.py
  - clip_volume_widget.py
  - line_widget.py
  - multi_slider_widget.py
  - plane_widget.py
  - README.rst
  - slider_bar_widget.py
  - sphere_widget.py
  - spline_widget.py
- - attenuation.py
  - beam_shape.py
  - light_actors.py
  - light_types.py
  - mesh_lighting.py
  - plotter_lighting.py
  - README.rst
  - shadows.py
- - dataframe_export.py
  - project_points_tessellate.py
  - README.rst
- - add_example.py
  - anatomical_groups.py
  - antarctica.py
  - atomic_orbitals.py
  - customize_trame_toolbar.py
  - extending_pyvista.py
  - fea_hertzian_contact_pressure.py
  - gyroid.py
  - magnetic_fields.py
  - mesh_validation.py
  - openfoam.py
  - openfoam_cooling.py
  - openfoam_tubes.py
  - planets.py
  - plotting_algorithms.py
  - pump_bracket.py
  - ray_trace_moeller.py
  - README.rst
  - sphere_eversion.py
  - warp_by_vector_eigenmodes.py
- README.rst
- ruff.toml
- gallery_docstrings.py
- warnings.py
- - forge-iso.png
- paper.bib
- paper.md
- pyvista.pdf
- pyvista.png
- pyvista.svg
- pyvista_sm.png
- pyvista_sm_sq.png
- pyvista_sq.png
- pyvista_sq.svg
- - __init__.py
  - app.py
  - compare.py
  - convert.py
  - plot.py
  - report.py
  - utils.py
  - validate.py
- - __init__.py
  - _vtk_utilities.py
  - cell.py
  - celltype.py
  - composite.py
  - config.py
  - dataobject.py
  - dataset.py
  - datasetattributes.py
  - errors.py
  - formatting_html.py
  - grid.py
  - objects.py
  - partitioned.py
  - pointset.py
  - pyvista_ndarray.py
  - wrappers.py
- - __init__.py
  - demos.py
  - logo.py
  - t_mesh.ply
- - 2k_earth_daymap.jpg
  - __init__.py
  - _dataset_loader.py
  - airplane.ply
  - ant.ply
  - cells.py
  - channels.vti
  - download_3ds.py
  - downloads.py
  - examples.py
  - frog_tissues.vti
  - globe.vtk
  - gltf.py
  - hexbeam.vtk
  - nut.ply
  - planets.py
  - pyvista_logo.png
  - rectilinear.vtk
  - sphere.ply
  - uniform.vtk
  - vrml.py
- - __init__.py
  - _autoenum.py
  - plot_directive.py
  - viewer_directive.py
- - __init__.py
  - notebook.py
- - __init__.py
  - _plotting.py
  - _property.py
  - _typing.py
  - actor.py
  - actor_properties.py
  - affine_widget.py
  - axes.py
  - axes_actor.py
  - axes_assembly.py
  - background_renderer.py
  - camera.py
  - charts.py
  - colors.py
  - component_registry.py
  - composite_mapper.py
  - cube_axes_actor.py
  - errors.py
  - follower.py
  - helpers.py
  - interactor_style_registry.py
  - lights.py
  - lookup_table.py
  - mapper.py
  - opts.py
  - picking.py
  - plot_compare.py
  - plotter.py
  - prop3d.py
  - prop_collection.py
  - render_passes.py
  - render_window_interactor.py
  - renderer.py
  - renderers.py
  - scalar_bars.py
  - text.py
  - texture.py
  - theme_registry.py
  - themes.py
  - tools.py
  - volume.py
  - volume_property.py
  - widgets.py
- - __init__.py
  - jupyter.py
  - views.py
- - __init__.py
  - mypy_plugin.py
- - __init__.py
  - algorithms.py
  - arrays.py
  - cell_type_helper.py
  - cells.py
  - common.py
  - docs.py
  - errors.py
  - features.py
  - fileio.py
  - geometric_objects.py
  - helpers.py
  - misc.py
  - parametric_objects.py
  - reader.py
  - regression.py
  - sphinx_gallery.py
  - transformations.py
  - wrappers.py
  - xvfb.py
- __init__.py
- __main__.py
- _deprecate_positional_args.py
- _plot.py
- _version.py
- _vtk.py
- _warn_external.py
- conftest.py
- errors.py
- py.typed
- report.py
- - __init__.py
  - test_accessor_registry.py
  - test_cells.py
  - test_composite.py
  - test_dataobject.py
  - test_dataobject_filters.py
  - test_dataset.py
  - test_dataset_filters.py
  - test_datasetattributes.py
  - test_formatting_html.py
  - test_frd.py
  - test_gc.py
  - test_geometric_objects.py
  - test_geometric_sources.py
  - test_grid.py
  - test_helpers.py
  - test_image_sources.py
  - test_imagedata_filters.py
  - test_imaging.py
  - test_objects.py
  - test_parametric_geometry.py
  - test_partitioned.py
  - test_pointset.py
  - test_polydata.py
  - test_polydata_filters.py
  - test_pyvista_ndarray.py
  - test_reader.py
  - test_reader_registry.py
  - test_rectilinear_grid_filters.py
  - test_unstructured_grid_filters.py
  - test_utilities.py
  - test_validation.py
  - test_writer_registry.py
- __init__.py
- check_doctest_names.py
- conftest.py
.codacy.yml
.dockerignore
.git-blame-ignore-revs
.gitattributes
.gitignore
.gitpod.yml
.mailmap
.pre-commit-config.yaml
AGENTS.md
AUTHORS.rst
CITATION.cff
CITATION.rst
CLAUDE.md
CODE_OF_CONDUCT.md
codecov.yml
context7.json
CONTRIBUTING.rst
FUNDING.yml
LICENSE
lychee.toml
Makefile
MANIFEST.in
pyproject.toml
README.md
README.rst
SECURITY.md

# Installation Guide

1. Get the code

git clone https://github.com/pyvista/pyvista

Downloads the entire project code from GitHub to your computer.

cd pyvista

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Python 3 Python is required to use pip.

pip install pyvista

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -f docker/Dockerfile -t pyvista .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 pyvista

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install pyvista

Installs the package published on PyPI directly — no need to clone the source.

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

5. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

pyvista

File Explorer

# Installation Guide

2. Official Install Script

3. Docker

4. Python

5. Make

Today's picks

Was this content helpful?

Recent Feedback

pyvista

File Explorer

# Installation Guide

2. Official Install Script

3. Docker

4. Python

5. Make

Today's picks

Was this content helpful?

Recent Feedback

Download README