tvt173 / awesome_photonics

😎 curated list of open source photonics projects

Awesome Photonics

A curated list of awesome resource for photonic engineers, physicists and hobbyists

Most tools in this list are written or have a python interface, which require some basic knowledge of python. If you are new to python you can find many books, YouTube videos and courses available online. If you are new to Git and Python I recommend reading this article

Contents

• layout: define the geometrical shapes that guide the light.
• simulation: simulate how photons propagate, and optimize the geometrical shapes
• lab automation: Control instruments in the lab
• data analysis
• visualization
• electronics
• other links

layout

• gdspy based tools

  • gdsfactory docs code - includes plugins to other tools.
  • phidl - made for superconducting detectors
    • soen-pdk docs and code
  • picwriter

• gdstk - from gdspy author, made it faster

  • pyphotonics

• klayout - layout viewer with python API

  • xsection, klayout-ipc, klayout-gadgets, lytest, lymask
  • zero-pdk - klayout pure python pdk.
  • KQcircuits - Quantum circuits pdk.
  • siepic-tools - code driven PCells and GUI driven layouts.
  • siepic-ebeam-pdk
  • gds3xtrude
  • spicex: netlist extraction
  • simplify polygons
  • klayout python
  • klayout cross-section in python - Port from ruby to python to xsection macro

• shapely based tools

  • gdshelpers - includes superconducting detectors.
  • dphox - includes 3D MEMs structures

• masque

• klamath

• nazca

• Technology Specific:

  • Ayar cell generator
  • BerkeleyPhotonicsGenerator
  • qiskit-metal - IBM superconducting based qubits.

• layout viewers

  • klayout - Best open source layout viewer.
  • GDS3D
  • GDS2WebGL

simulation

• mode solver:

  • Finite Difference
    • modes
    • EMpy
    • philsol - Allows bends.
    • pymode - Allows bends.
      • wgms3d
    • pyMWM
    • mpb - Bloch mode solver.

• component design:

  • FDTD - Finite differences time domain.
    • meep FDTD
      • meep ipkiss integration
      • meep docker image - code
      • grating coupler example
    • emopt FDTD
    • Python 3D FDTD simulator - Written in PyTorch.
    • tidy3d client docs and code - Server is propietary.
    • GSvit - GPU support
  • FDFD - Finite differences frequency domain.
    • spins FDFD on GPU
    • ceviche (2D only) FDTD and FDFD
    • jaxwell
  • EME - Eigen mode expansion.
    • emepy
    • CAMFR
  • RCWA:
    • S4
    • grcwa - automatic differentiation included with autograd
  • SiPANN (neural networks for photonics component design)
  • inverse design
    • glonet: global optimization based on generative neural networks
    • wavetorch
    • lumopt
    • angler - Frequency-domain photonic simulation and inverse design optimization for linear and nonlinear devices.
    • SPLayout code docs
    • ceviche-challenges code - Photonic inverse designs based on the FDFD simulator Ceviche
    • NIDN - Inverse design of metamaterials, photonic crystals, ... using PyTorch
  • TCAD tcad repos TCAD Overview spreadsheet here
    • devsim - Semiconductor Device Simulator
    • BOSIM
    • Suprem4 - Process simulator (no python)
    • pisces - Poison and continuity equation solver (no python)
    • TCAD docker containers
    • Charon - Paralell TCAD simulator. GitHub mirror
  • ray tracing:
    • ray tracing
    • rayopt
  • adaptive optics
    • AOtools
  • multisolvers
    • simphox (FDTD, beamPropagation, circuit simulation)
  • transfer matrix
    • TMM

• circuit simulation:

  • SAX code and docs - Differentiable circuit solver.
  • simphony (linear circuit solver)
  • photontorch docs - code - Includes time domain.
  • opics
  • SignalIntegrity (linear circuit simulation)
  • scikit-rf RF simulator
  • pyFDA filter design code and docs
  • Xyce - open source, SPICE-compatible, high-performance analog circuit simulator.

• material database

  • rii pandas

• lithography simulation

  • optolithium
  • notebooks
  • dimmilitho
  • keras based litho model

verification

• parasitic extraction
  • speedsterpy

lab automation

• backend:

  • PyVISA - Allows you to control the lab instruments with python. As the backend you can use NI or PyVISA-py.
  • PySerial - Issue simple serial commands (RS-232, RS485) to instruments (and read data).

• lab automation repos:

  • lightlab repo docs
  • instrumental
  • pymeasure
  • pyrolab
  • LabEXT docs and code
  • hardware testing framework - Google
  • pic-wafer - MIT
  • laval python lab
  • ubc automated pic-tester
  • labrad
  • autogator - camera-assisted motion control and experiment configuration of photonic integrated circuit interrogation platforms.

data analysis

• pandas
• dask
• wafermap

Visualization

• Klayout for GDS files
• Meshlab for STL
• ParaView for data visualization

electronics

• schematic capture:

  • skidl: netlist formatting, writing, and reading
  • elkjs code demo - Javascript schematic editor.

• layout

  • kicad PCB layout python
  • VLSI placement

• circuit simulation

  • lcapy - Linear circuit analysis.
  • pyspice
  • Spice book

• open source pdks

  • skywater-pdk

other links

• princeton notebooks
• https://hackmd.io/@joamatab/rJngxJudr#/
• https://git.shivering-isles.com/shivering-isles/infrastructure
• https://github.com/awesome-selfhosted/awesome-selfhosted
• epda
• Awesome quantum
• Awesome electronics
• Awesome lists