Use Python to analyze data, automate complex workflows\optimizations, and produce publication-quality plots. The Ansys Lumerical Python APIs provides a method to seamlessly use Python to interact with Ansys Lumerical products.
The Ansys Lumerical Python APIs provide automation capabilities (lumapi), an inverse design and optimization module (lumopt), and a Slurm scheduler integration module for using Ansys Lumerical products with high-performance computing.
Python v3 is included with all Ansys Lumerical products, which enables you to directly run Python scripts from the in-product scripting environment. This page provides various guides and examples to get you started on using the Python API.
Product Automation (lumapi)
Use the Python API to interact and automate simulations in Ansys Lumerical FDTD™, Ansys Lumerical MODE™, Ansys Lumerical Multiphysics™, and Ansys Lumerical INTERCONNECT™.
Guides
- Installation and Getting Started
- Session Management
- Script Commands as Methods
- Working with Simulation Objects
- Passing Data
- Accessing Simulation Results
- Python API Reference
- Interop Server - Remote API
Application Examples
Application Gallery examples demonstrating how to get started using the Lumerical Python API to interact with Ansys Lumerical products.
Ansys Lumerical FDTD™
Ansys Lumerical INTERCONNECT™
Inverse Design (lumopt)
Utilize the lumopt inverse design and optimization module to find optimal designs for photonic components.
Guides
- Photonic Inverse Design Overview - Python API
- Getting Started with lumopt - Python API
- Optimizable Geometry - Python API
Application Examples
Application Gallery examples to get started with using lumopt for inverse design problems. A complete list of examples can be found in the Inverse Design Optimization category of the Application Gallery.
Scheduler for HPC (lumslurm)
Use the lumslurm module to automate job submission on high-performance computing (HPC) clusters using the Slurm scheduler where license utilization and performance are imperative.