pyvista report#
Command-line interface for generating a PyVista software environment report.
Using pyvista report is similar to creating a Report in Python.
Examples#
Show a PyVista report.
$ pyvista report
--------------------------------------------------------------------------------
Date: Tue Sep 08 02:55:32 2026 UTC
OS : Linux (Ubuntu 22.04)
CPU(s) : 8
Machine : x86_64
Architecture : 64bit
RAM : 30.9 GiB
Environment : Python
File system : ext4
GPU Vendor : Mesa
GPU Renderer : llvmpipe (LLVM 15.0.7, 256 bits)
GPU Version : 4.5 (Core Profile) Mesa 23.2.1-1ubuntu3.1~22.04.4
Render Window : vtkEGLRenderWindow
MathText Support : True
Python 3.14.2 (main, Dec 8 2025, 02:54:03) [GCC 11.4.0]
pyvista : 0.49.0
vtk : 9.7.0
numpy : 2.5.3
matplotlib : 3.11.1
scooby : 0.11.2
pooch : 1.9.0
pillow : 12.3.0
typing-extensions : 4.16.0
cyclopts : 4.25.0
pyvista-validation : 0.2.2
IPython : 9.17.1
scipy : 1.16.3
tqdm : 4.70.0
fsspec : 2026.7.0
imageio : 2.37.4
meshio : 5.3.5
pyvista-frd-reader : 0.2.1
pyvista-miniply : 0.5.2
pyvista-stl : 0.5.3
pyvista-zstd : 0.4.0
cmcrameri : 1.10
cmocean : 4.0.3
colorcet : 3.2.1
trame-pyvista : 0.1.7
ipywidgets : 8.1.9
jupyterlab : 4.6.3
nest-asyncio2 : 1.7.2
--------------------------------------------------------------------------------
API Reference#
Show the output from pyvista report --help.
$ pyvista report --help
Usage: pyvista report [ARGS]
Generate a PyVista software environment report.
╭─ Parameters ─────────────────────────────────────────────────────────────────╮
│ Option Default Description │
│ ADDITIONAL --additional - List of packages or package names │
│ --empty-additional to add to output information. │
│ NCOL --ncol 3 Number of package-columns in html │
│ table; only has effect if │
│ mode='HTML' or mode='html'. │
│ TEXT-WIDTH --text-width 80 The text width for non-HTML │
│ display modes. │
│ SORT --sort --no-sort False Alphabetically sort the packages. │
│ GPU --gpu --no-gpu True Gather information about the GPU. │
│ Defaults to True but if │
│ experiencing rendering issues, │
│ pass False to safely generate a │
│ report. │
│ DOWNLOADS --downloads False Gather information about │
│ --no-downloads downloads. If True, includes: │
│ │
│ • The local user data path │
│ (where downloads are saved) │
│ • The data source (where files │
│ are downloaded from) │
│ • Whether local file caching is │
│ enabled for the data source │
│ │
│ These are the resolved values in │
│ use, derived from the │
│ :envvar:PYVISTA_USERDATA_PATH and │
│ :envvar:PYVISTA_DATA environment │
│ variables. Pass env_vars=True to │
│ also list the raw variables as │
│ set. │
│ │
│ .. versionadded:: 0.47 │
│ ENV-VARS --env-vars False List any set PYVISTA_* │
│ --no-env-vars environment variables. These are │
│ the raw inputs read from the │
│ environment, not the settings │
│ derived from them; for the │
│ derived download settings, see │
│ downloads. Values may include │
│ local file paths (such as a user │
│ name), so only enable this when │
│ sharing the report is acceptable. │
│ │
│ .. versionadded:: 0.49 │
╰──────────────────────────────────────────────────────────────────────────────╯
