pyvisual Documentation#
pyvisual is developed and maintained by Predictive Science Inc. (PSI) and provides an interactive 3D visualization layer
for solar and magnetohydrodynamic (MHD) model output defined on spherical coordinate
systems. It wraps pyvista.Plotter with spherical-coordinate awareness,
observer controls, and rendering utilities tuned to the PSI data ecosystem
(psi-io and
mapflpy).
The primary entry point is Plot3d, which exposes
methods for adding solar geometry primitives, rendering structured-grid slices and
isosurface contours, plotting point clouds and splines, and tracing magnetic
fieldlines — all from spherical \((r, \theta, \phi)\) coordinate arrays.
Because pyvisual renders through PyVista (which is,
itself, a pythonic interface for the VTK library),
it is strongly recommended to familiarise yourself with the PyVista documentation to
get the most out of the package.
pyvisual is in active development. Although the existing API will remain unchanged, additional quality-of-life improvements are forthcoming. Please direct any comments, concerns, or issues to the Predictive Science Inc. research team via the distro Issue Tracker or contact form.
Attention
Please be aware that pyvisual is available through the Python Package Index (PyPI) as
psi-pyvisual. Further installation instructions are available in the
User Guide.
Installation instructions, coordinate conventions, and an architectural
overview of the Plot3d class and its
mixin components.
Worked examples covering basic scenes, slicing, fieldlines, observer controls, and the mesh class API — organized by functional area.
Full API documentation for all public classes, methods, functions, and type aliases auto-generated from source docstrings.