optical-automation
optical-automation copied to clipboard
Optical Automation Framework
Optical Automation Library ##########################
Overview
The Optical Automation library gathers functionalities and tools for Ansys Speos, Zemax, and Lumerical automations and interoperations.
For Speos, this library allows you to create workflows combining different preprocessing and postprocessing modules.
Installation
To install the Optical Automation library, run this code in the Windows command prompt:
.. code:: console
curl https://github.com/ansys/optical-automation/archive/refs/heads/main.zip -LJ --output main.zip tar -xf main.zip move optical-automation-main\ansys_optical_automation "%AppData%\SpaceClaim\Published Scripts"
Documentation
You can read API documentation here: Ansys Optical Automation <https://ansys.github.io/optical-automation/>_.
Examples
Examples on how to use the created modules you can find under application <https://github.com/ansys/optical-automation /tree/main/ansys_optical_automation/application>_
Contribution
Contributions to this library are welcome. To learn how to contribute, see the
Contribute <doc/resources/CONTRIBUTE.rst>_ document.
License
The Optical Automation library is licensed under the MIT license.
The full license can be found in the root directory of the optical-automation <https://github.com/ansys/optical-automation>_ repository.