Report

Report(

additional: list[str | ModuleType] | None = None,

ncol: int = 3,

text_width: int = 80,

sort: bool = False,

gpu: bool = True,

downloads: bool = False,

)

Generate a PyVista software environment report.

Added in version 0.47: The report can now be generated using the shell command:

pyvista report --sort ...

Run pyvista report --help for more details on available parameters.

Parameters:

additionalsequence[types.ModuleType], sequence[str]

List of packages or package names to add to output information.

ncolint, default: 3

Number of package-columns in html table; only has effect if mode='HTML' or mode='html'.

text_widthint, default: 80

The text width for non-HTML display modes.

sortbool, default: False

Alphabetically sort the packages.

gpubool, default: True

Gather information about the GPU. Defaults to True but if experiencing rendering issues, pass False to safely generate a report.

downloadsbool, default: False

Gather information about 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

Added in version 0.47.

Examples

>>> import pyvista as pv
>>> pv.Report()
  Date: Fri Oct 28 15:54:11 2022 MDT

                OS : Linux
            CPU(s) : 6
           Machine : x86_64
      Architecture : 64bit
               RAM : 62.6 GiB
       Environment : IPython
       File system : ext4
        GPU Vendor : NVIDIA Corporation
      GPU Renderer : Quadro P2000/PCIe/SSE2
       GPU Version : 4.5.0 NVIDIA 470.141.03

  Python 3.8.10 (default, Jun 22 2022, 20:18:18)  [GCC 9.4.0]

           pyvista : 0.37.dev0
               vtk : 9.1.0
             numpy : 1.23.3
           imageio : 2.22.0
            scooby : 0.7.1.dev1+gf097dad
             pooch : v1.6.0
        matplotlib : 3.6.0
           IPython : 7.31.0
          colorcet : 3.0.1
           cmocean : 2.0
             scipy : 1.9.1
              tqdm : 4.64.1
            meshio : 5.3.4
        jupyterlab : 3.4.7