Adding components and models to the PDK

Adding components and models to the PDK

This page describes the steps to add components to the PDK, including 1) layout cells, 2) compact models, 3) linking the layout and model to enable post-layout simulations.

The implementation uses KLayout and Lumerical INTERCONNECT

Install the PDK in developer mode

• Use the GitHub installation approach for the PDK SiEPIC_EBeam_PDK installation

Install the compact model library (CML) in INTERCONNECT from KLayout

• In KLayout:
  • Create a new layout using the PDK Technology
  • SiEPIC > Simulation, Circuits > Setup Lumerical INTERCONNECT Compact Model Library
    • you should see INTERCONNECT run and close, then a dialog that indicates success
• In INTERCONNECT:
  • in the Elements window, under Design Kits, you should see the Technology appear in the list
  • Note that it is Read-Only, so you cannot make contributions this way. This method is for End Users.

Install the CML in INTERCONNECT as a Custom library

• in Windows:
  • Find out where the Custom library folder is
    • In INTERCONNECT:
      • in the Elements window, find Custom
      • right-click Custom and Redirect, to find out the folder location
      • e.g., C:\Users\Photonics\AppData\Roaming\Custom, replace Photonics with your own user name
      • Close INTERCONNECT
  • Create a symbolic link from the GitHub CML folder to the Lumerical Custom folder:
    • reference: https://www.howtogeek.com/16226/complete-guide-to-symbolic-links-symlinks-on-windows-or-linux/
    • Start menu: "cmd" to start Command Prompt, right click "Run as Administrator"
      • mklink /D %userprofile%\AppData\Roaming\Custom\EBeam %userprofile%\Documents\GitHub\SiEPIC_EBeam_PDK\klayout\EBeam\CML\EBeam
        • where the Technology is EBeam
  • Restart INTERCONNECT, and you should see the Technology under both Custom and Design Kit

Create a new component

Copy & Edit approach

• Example, start with ebeam_wg_integral_1550
• Edit: prefix, model
• Edit other things
• Right-click on the component, "Copy to Element Library"

GitHub

• You should see a new .ice file in the CML folder
• Commit to GitHub / Pull Request