User guide#

Use Python to analyze data, automate complex workflows, optimizations, and produce publication-quality plots. PyLumerical provides a method to seamlessly use Python to interact with Ansys Lumerical products.

This user guide provides important informational resources on key concepts of PyLumerical.

Simulation automation#

The guides below discusses using lumapi to automate Lumerical simulations with Python.

Session management

Learn how to open, close and interact with Lumerical products through sessions.

Session management
Script commands as methods

Learn how to interact with Lumerical products using script commands.

Script commands as methods
Working with simulation objects

Learning how to create and manipulate simulation objects.

Working with simulation objects
Passing data

Learning how data types are transferred between Lumerical and Python.

Passing data
Accessing simulation results

Learn how to access simulation results and work with Lumerical datasets.

Accessing simulation results

Photonic inverse design#

The article below discusses usage of lumopt2 for inverse design of photonic devices, along with a few getting started examples.

Introduction to photonic inverse design with lumopt2

Learn how to install and use the lumopt2 module for photonic inverse design.

Introduction to photonic inverse design with lumopt2
Getting started: Simple metalens example

Get a quick introduction to using lumopt2 through a simple metalens optimization example.

Getting started with lumopt2: simple metalens
Getting started: L-bend example

Learn how to optimize components for integrated photonic circuits through a simple L-bend example.

Getting started with lumopt2: L-bend

Start with the article below to learn the details of lumopt2.

Optimization session

Learn about the optimization session, which is the core of the photonic inverse design workflow with lumopt2.

Optimization session in lumopt2