Skip to content

ansys/pylumerical

PyLumerical

PyAnsys Python PyPI Codecov GH-CI MIT Ruff

A Python wrapper for Ansys Lumerical products.

Installing PyLumerical as a user

You must have an Ansys Lumerical GUI license to use PyLumerical.

You can install PyLumerical using pip.

First, ensure that you have the latest pip version:

python -m pip install -U pip

Then, install using:

python -m pip install ansys-lumerical-core

For more information, see the installation and getting started section in the documentation.

Contributing to PyLumerical

For guidelines on contribution and how to install PyLumerical as a developer, see the contributing section section in the documentation.

Getting started

Please see the installation and getting started section in the documentation for more information.