Skip to main content

Speos for developers

Overview

Ansys Speos optical design software uniquely simulates a system’s optical performance and evaluates the final illumination effect, based on human vision. For more information, see Ansys Speos.
 

Speos APIs (Application Programming Interfaces) offer you the capability to:

  • Access all features provided by the GUI through the Speos client APIs.
  • Automate the management of input and output data through the Speos Labs automation APIs.

The Speos client APIs are intricately linked to the GUI, ensuring that every functionality accessible in the GUI has 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 client APIs consist of three distinct interfaces:

  • SpeosSim: Offers a comprehensive suite of Light Simulation features.
  • SpeosDes: Encompasses all Optical Part Design features.
  • SpeosAsm: Provides the Geometry Update feature.

The Speos Labs automation APIs enable you to perform preprocessing and postprocessing tasks on input data and simulation results from Speos.

OS and supported languages

Speos Client APIs are available for Windows in:

  • IronPython

Speos Labs automation APIs are available for Windows in:

  • VB Script, C++

Documentation

Speos client APIs documentation

Provides API references and methods for the SpeosSim, SpeosDes, and SpeosAsm interfaces.
 

2023 R2

2024 R1

Speos client APIs methods (customer login required)

Details cross-functional methods applicable across the three interfaces described in the Speos client APIs references.  

2023 R2

From version 2024 R1 onwards, the documentation for Speos client APIs methods has been included into the Speos client APIs documentation.

Speos Labs automation APIs 

Provides both general information and API references for automation.

2023 R2 

2024 R1

Related projects

 When using Speos APIs, you can perform further development with the APIs and libraries of these Ansys products: