Registry /
data / ansys-tools-visualization-interface
Install & Compatibility
Where this runs
tested against v0.13.3 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.95 runs
build_error
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 18.6s · import 0.094s · 881MB
846MB installed
● package 846MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
Plotter
✓ from ansys.tools.visualization_interface import Plotter
✗ from ansys_tools_visualization_interface import Plotter
Hyphens in package name must be replaced with underscores in import path.
PyVistaBackend
✓ from ansys.tools.visualization_interface.backends.pyvista import PyVistaBackend
✗ from ansys.tools.visualization_interface.backends import PyVistaBackend
PyVistaBackend is not exposed from the backends package directly; must import from the submodule.
Basic example creating a triangular mesh and displaying it using the default backend.
from ansys.tools.visualization_interface import Plotter
import numpy as np
# Create a simple mesh
points = np.array([[0, 0, 0], [1, 0, 0], [0, 1, 0], [0, 0, 1]])
cells = np.array([[0, 1, 2], [0, 1, 3], [0, 2, 3], [1, 2, 3]])
cell_types = np.array([5, 5, 5, 5]) # Triangle
# Initialize plotter and add mesh
plotter = Plotter()
plotter.add_mesh(points, cells, cell_types)
plotter.show()
Debug
Known issues
breakingThe v1.0.0a1 pre-release introduces breaking changes in the API. The `Plotter` class and backend interfaces have been refactored. Existing code using v0.12.x may not work with v1.0.0a1 without migration.fixReview the migration guide at https://github.com/ansys/ansys-tools-visualization-interface/blob/main/doc/source/migration_guide.rst before upgrading.
affects: >=1.0.0a0
deprecatedThe `add_scalar_field` method in v0.12.x is deprecated and will be removed in v1.0.0. Use `add_field` instead.fixReplace `add_scalar_field(...)` with `add_field(scalar_data=..., ...)`.
affects: 0.12.0 to 0.12.1
gotchaBackend selection must be done at initialization; you cannot switch backends after creating a Plotter instance.fixPass backend='pyvista' or backend='plotly' to Plotter constructor.
affects: all
Errors
Common errors & fixes
ModuleNotFoundError: No module named 'ansys'
The package is not installed or the import path uses hyphens incorrectly.
fixInstall the package: pip install ansys-tools-visualization-interface. Then import with underscores: from ansys.tools.visualization_interface import ...
AttributeError: module 'ansys.tools.visualization_interface' has no attribute 'Plotter'
The import statement is incorrect; the Plotter class is not a top-level attribute of the module.
fixUse: from ansys.tools.visualization_interface import Plotter
ValueError: Unsupported backend 'plotly' – only 'pyvista' is supported.
Plotly backend is an optional dependency and not installed by default.
fixInstall with plotly support: pip install ansys-tools-visualization-interface[plotly]
Upgrade
Version history
0.13.3latest on PyPI · released May 22, 2026
Audit
Dependencies
pyvistarequiredCore backend for 3D visualization.
plotlyoptionalOptional backend for interactive web-based plots.
numpyrequiredNumerical computations for mesh data.