PyLumerical documentation 0.1.0#
PyLumerical is the Python automation library for Ansys Lumerical photonics simulation software. Use PyLumerical to seamlessly control Ansys Lumerical products including Ansys Lumerical FDTD™, Ansys Lumerical MODE™, Ansys Lumerical Multiphysics™, and Ansys Lumerical INTERCONNECT™ directly in Python.
You can use PyLumerical to set up geometry and material, run simulations, and retrieve results from Lumerical products, while leveraging the power of extensive Python libraries.
If you have existing automation in the Lumerical Scripting Language, you can also use them seamlessly with PyLumerical, and build your Python workflow around them.
As a part of the PyAnsys project, PyLumerical also enables you to integrate with other Ansys products to create complex and accurate multiphysics workflows.
Note
The Lumerical inverse design library lumopt and the high performance computing (HPC) scheduler automation library lumslurm are currently only available as a part of the Lumerical Python API and cannot be accessed in PyLumerical.
The Lumerical Python API is still provided with Lumerical products. If you wish to use the Lumerical Python API instead of PyLumerical, please see the Lumerical Python API documentation in the Lumerical Knowledge Base.
New to PyLumerical? This quick start guide provides you with information to rapidly get started.
In-depth information on key concepts of PyLumerical.
Description of classes and methods of the PyLumerical module.