pgkyl pyvista

Usage: pgkyl pyvista [OPTIONS]

  Render a 3-D scalar field with PyVista.

  Builds a structured grid from the (single-component) scalar values and renders it as a
  volume, contour isosurfaces, or an interactive clip/slice plane. The grid is
  normalized to ``aspect_ratio`` because PyVista handles non-integer axis extents
  poorly. Only the first value component is used.

Options:
  -n, --no_show [BOOLEAN]         Do not open an interactive render window; render off-
                                  screen.  [default: False]
  --no_spin [BOOLEAN]             Do not auto-rotate the camera in interactive windows.
                                  [default: False]
  -m, --max_points_per_axis INTEGER
                                  downsample to at most this many points per axis;
                                  ``-1`` disables downsampling.  [default: -1]
  -c, --contour_levels INTEGER    Number of isosurfaces extracted unless ``volume`` is
                                  set.  [default: 10]
  -i, --is_log [BOOLEAN]          color by log10 of the scalar (non-positive values
                                  masked).  [default: False]
  -v, --volume [BOOLEAN]          Render a volume instead of isosurface contours.
                                  [default: False]
  --is_shaded [BOOLEAN]           enable shading on the volume render (volume mode
                                  only).  [default: False]
  --hide_axes [BOOLEAN]           hide the bounding-box axes and labels.  [default:
                                  False]
  --mesh_clip_plane [BOOLEAN]     add an interactive clip plane along ``-x``.  [default:
                                  False]
  --mesh_slice_plane [BOOLEAN]    add an interactive slice plane along ``-x``.
                                  [default: False]
  --volume_clip_plane [BOOLEAN]   add an interactive volume clip plane (volume mode).
                                  [default: False]
  --cmin FLOAT                    Color-limit lower bound; defaults to the data minimum.
  --cmax FLOAT                    Color-limit upper bound; defaults to the data maximum.
  -a, --aspect_ratio <FLOAT FLOAT FLOAT>...
                                  per-axis aspect the grid is normalized to.  [default:
                                  1, 1, 1]
  --camera_azimuth FLOAT          Initial camera azimuth in degrees.  [default: 0.0]
  --camera_elevation FLOAT        Initial camera elevation in degrees.  [default: -30.0]
  -o, --opacity TEXT              a PyVista opacity preset string, ``"diverging"``
                                  (opaque at both ends, transparent in the middle), or a
                                  scalar opacity.  [default: sigmoid_4]
  --cmap TEXT                     colormap name; overridden to ``"RdBu_r"`` when
                                  ``diverging``.  [default: inferno]
  -x, --xlabel TEXT               Horizontal-axis label; auto-derived when omitted.
  -y, --ylabel TEXT               Vertical-axis label; auto-derived when omitted.
  -z, --zlabel TEXT               Third-axis label; auto-derived when omitted.
  --clabel TEXT                   colorbar (scalar bar) title.  [default: ""]
  -t, --title TEXT                text drawn at the top of the render; omitted when
                                  ``None``.  [default: ""]
  -d, --diverging [BOOLEAN]       use the diverging ``"RdBu_r"`` colormap.  [default:
                                  False]
  --cylindrical_to_cartesian [BOOLEAN]
                                  treat grid coordinates as cylindrical ``(R, Z, phi)``
                                  and convert to Cartesian before building the mesh.
                                  [default: False]
  --theme TEXT                    PyVista plot theme name; ``"default"`` leaves it
                                  unchanged.  [default: default]
  -s, --saveas TEXT               output path; extension selects the exporter
                                  (``.html``, ``.png``/``.jpg``/``.jpeg``,
                                  ``.pdf``/``.svg``, ``.gltf``, ``.vtksz``). Empty
                                  string disables saving.  [default: ""]
  --xscale FLOAT                  Multiplicative scale recorded for the horizontal axis.
                                  [default: 1.0]
  --yscale FLOAT                  Multiplicative scale recorded for the vertical axis.
                                  [default: 1.0]
  --zscale FLOAT                  Multiplicative scale recorded for the third axis.
                                  [default: 1.0]
  --xshift FLOAT                  Additive shift applied to the horizontal axis.
                                  [default: 0.0]
  --yshift FLOAT                  Additive shift applied to the vertical axis.
                                  [default: 0.0]
  --zshift FLOAT                  Additive shift applied to the third axis.  [default:
                                  0.0]
  --hide_zeros [BOOLEAN]          hide grid points whose scalar value is exactly zero.
                                  [default: False]
  --help                          Show this message and exit.

Python API