OPICS reference documentation

For an introduction to OPICS, start at the OPICS GitHub page.

Quickstart

• Installing and Building
  • installing from pypi
  • Building from source

Libraries

• EBeam library

Tutorials

• Mach-Zehnder Interferometer (MZI)
  • Import component library
  • Define network
  • Add circuit components
  • Define circuit connectivity
  • Simuate the circuit
  • Visualize the simulation result
• Micro Ring Resonator (MRR)
  • Import component library
  • Define network
  • Add circuit components
  • Define circuit connectivity
  • Simulate the circuit
  • Visualize the simulation result

Notes

• Credits
  • Main Author
  • Contributors

API documentation

• Public API: opics package
  • components types
  • opics.components module
  • opics.network module
  • opics.sparam_ops module
  • opics.utils module

Indices and tables

• Index

• Module Index

• Search Page