Skip to main content

Speos Overview

Ansys Speos® CAD integrated optical and lighting simulation software uniquely simulates a system’s optical performance and evaluates the final illumination effect, based on human vision. For more information, see the Ansys Speos product page. Speos APIs (Application Programming Interfaces) offer you the capability to:

  • Access features provided by the Speos for SpaceClaim GUI through the Speos client APIs.
  • Access features provided by the Speos for NX GUI through the Speos for NX library.
  • Automate the management of input and output data through the Speos Labs automation APIs.
  • Automate external simulation through the Speos Core methods.
  • Access features provided by the Speos solver, with more liberty, through the Speos RPC.
  • Access the features and tools of the Speos solver through the PySpeos Python client library, which is built on Speos RPC.
The Speos client APIs and Speos for NX library are intricately linked to the GUI, ensuring that the functionalities accessible in the GUI have a corresponding automation function. As the automation functions are directly derived from the GUI, they perfectly align with the actions you would perform in the software, such as creating new Speos objects, editing existing ones, and modifying parameters.  The Speos Labs automation APIs enable you to perform preprocessing and postprocessing tasks on input data and simulation results from Speos software. The Speos Core methods enable you to run locally exported simulations from a Speos software or on a network while keeping Speos software available. The Speos RPC is based on a gRPC server and provides APIs to interact with Speos Solver. This allows you to use the Speos capabilities without starting any CAD and therefore offers the possibility to manage Speos capabilities with more liberty. The PySpeos library is a Python interface for accessing Speos RPC.

OS and supported languages

Speos APIs available only on Windows:

  • Speos client APIs: IronPython
  • Speos for NX library: Python
  • Speos Labs automation APIs: VB Script, C++
  • Speos Core methods: COM
Speos APIs available on Windows and Linux:
  • Speos RPC: All languages compatible with gRPC framework.
  • PySpeos: Python

Documentation

PySpeos

Documentation for PySpeos

Speos RPC

Documentation for Speos RPC.

Speos client APIs documentation

Documentation for Speos client APIs.

Speos for NX library

Documentation for Speos for NX library.

Speos Labs automation APIs

Documentation for Speos Labs automation APIs.

Speos Core methods

Documentation for Speos Core methods.