VISOR is a Python-based 3D visualization web component.
You can use VISOR to integrate with the following tools:
- SAF (Solution Application Framework) to provide 3D visualization capabilities.
- Ansys Dynamic Reporting to support dynamic reporting workflows.
- PyAnsys Visualization Interface Tool to connect PyAnsys libraries to different plotting backends.
You can use VISOR for 3D visualization on desktop and on premises. VISOR customizes existing rendering frameworks to meet functional and nonfunctional requirements, including integrability, scalability, performance, and usability for solution apps.
You run VISOR with VTK (Visual Toolkit) rendering and Trame to support a client-server architecture and Python integration workflows. You target VTK WASM with WebGL because WebGPU support is not yet available.
To set up prerequisites and install VISOR, see Getting started in the VISOR documentation.
For a basic usage example, see Quick start in the VISOR documentation.
To set up your development environment, see the Contributing.md file in the VISOR repository.
You can use VISOR through the following entry points. Links are to the relevant information in he VISOR documentation.
Standalone Python
- Launch a desktop VISOR app with the Python package
ansys.visor.viewerto visualize files. - See VISOR Python API for API usage examples.
- See API reference for details about the Python API.
- Launch a desktop VISOR app with the Python package
VISOR HTTP service
- Manage multiple VISOR instances through the VISOR HTTP API.
- Integrate with PIM (Product Instance Management) to manage VISOR instances in SAF apps.
- See VISOR HTTP service for usage examples.
- See HTTP API reference for API details.
Dash frontend app
- Connect to a VISOR instance from a Dash app with the VISOR Dash component in
ansys.visor.dash.dash_visor_viewer. - See VISOR Dash component for details.
- Connect to a VISOR instance from a Dash app with the VISOR Dash component in
For advanced usage and configuration options, see the following VISOR documentation:
User guide and Examples in the VISOR sections.