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: Thu Aug 06 06:06:59 2026 UTC
OS : Linux (Ubuntu 22.04)
CPU(s) : 8
Machine : x86_64
Architecture : 64bit
RAM : 31.0 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.dev0
vtk : 9.6.2
numpy : 2.4.6
matplotlib : 3.10.9
scooby : 0.11.2
pooch : 1.9.0
pillow : 12.3.0
typing-extensions : 4.16.0
cyclopts : 4.22.5
IPython : 9.16.1
scipy : 1.16.3
tqdm : 4.70.0
fsspec : 2026.6.0
imageio : 2.37.4
meshio : 5.3.5
cmcrameri : 1.9
cmocean : 4.0.3
colorcet : 3.2.1
trame-pyvista : 0.1.6
ipywidgets : 8.1.8
jupyterlab : 4.6.2
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 VTK Data source (where │
│ files are downloaded from) │
│ • Whether local file caching is │
│ enabled for the VTK Data │
│ source │
│ │
│ .. versionadded:: 0.47 │
╰──────────────────────────────────────────────────────────────────────────────╯
