Welcome

lumerical-py-scripts/

├── DEVICE
│   ├── electro_optic
│   └── pin_modulator
├── FDTD
│   ├── directional-coupler
│   ├── disk_resonator_coupler
│   ├── edge_coupler
│   ├── mmi-couplers
│   ├── ring_resonator_coupler
│   ├── swg_grating
│   ├── vertical_taper
│   ├── waveguide-bend
│   ├── waveguide_crossing
│   ├── waveguide_mode_taper
│   └── waveguide-straight
└── MODE
    ├── awg_star_coupler
    ├── butt_coupling
    ├── directional_coupler
    ├── edge_coupler
    ├── swg_grating
    ├── vertical_taper
    └── waveguide

Why this Repository?

In this repository, you will find useful scripts to optimize your workflow and automate your daily design tasks. All you need to do is modify the .py files under user_inputs in each subdirectory and run the scripts. The results will be shown on the interactive terminal and stored under a Result directory that will be created after you run the scripts. The repository is divided into three main simulation branches with multiple subcategories each:

1. 3D FDTD

2. MODE Solutions

awg-star-coupler: Calculates the far-field of an awg star-coupler.
butt-coupling: Calculates the overlap integral between two waveguides.
directional-coupler: Calculates the effective index of the supermodes and plots the coupling as a function of length.
edge-coupler: Calculates the overlap integral between a fiber mode (Gaussian) and a waveguide.
swg_grating: Calculates the frequency response (T/R) of a sub-waveelength grating (2.5D varFDTD).
vertical-taper: Calculates the effective index of vertical tapers over the propagation distance.
waveguide: Calculates the effective index, propagation loss, FSR and Q-factor. Metal and doping layers included.

3. DEVICE

electro-optic: Calcuates the Electrostatic Field across the waveguide layers, and calculates the index change for AlGaAs.
pin-modulator: Calculates the electrical parameters for the pin junction and extracts data for waveguide mode simulations.

Requirements

You need installed on your operating system the following software

Lumerical Software
Python3
Python Packages in requirements.txt (Numpy, Matplotlib, Shapely, etc)
Python IDE Software (i.e. Spyder)

Installation

Make sure you have Python 3 and the latest version of Lumerical Design Suite installed. In this repository, it is assumed that lumapi is integrated into the Python environment. Check the instructions below for Spyder and VSC.

Clone the repository and run the scripts under the root project folder. The code will create a Results folder, and you can check the saved data there. If Lumerical is installed on a Linux machine, remember to change the path \\ to / in config.py.

Spyder (Recommended)

Click on Tools -> PYTHONPATH manager and then Add Path.
Add the path to the lumapi, for example: C:\\Program Files\\Lumerical\\v222\\api\\python.

(Note: Your Lumerical Python API directory may differ from mine.)

Additionally, assign the root of the project directory to your PYTHONPATH manager since absolute paths are used to load the modules. For example: D:\Georgios\Python - Scripts\lumerical-py-scripts

Visual Studio Code

If you're coding on a Windows machine, add the following lines in the .json settings:

"terminal.integrated.env.windows": {
    "PYTHONPATH": "C:\\Program Files\\Lumerical\\v222\\api\\python;D:\\Georgios\\Python - Scripts\\lumerical-py-scripts"
},
"python.envFile": "${workspaceFolder}/.env"

(Note: The separator for Windows path is ; while for Linux path is :. The Pythonpath here contains the path of the lumapi and the root path of the project.)

Alternatively, you can create a file called .env under the root project directory to add your lumapi path and the directory of the root project. For example:

PYTHONPATH=C:\\Program Files\\Lumerical\\v222\\api\\python;D:\\Georgios\\Python-Scripts\\lumerical-py-scripts\\

Make sure to run the code with the Jupyter Interactive Python kernel to see the plots appear in the interactive terminal.

gcharalampous/lumerical-py-scripts