Toggle navigation

.rst .pdf

Contents

OPICS reference documentation

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

Quickstart

• OPICS Quickstart
  • Installing OPICS
    • Installing from pypi
    • Installing from source
  • OPICS Libraries
    • Listing available libraries
    • Downloading libraries
    • List installed libraries
    • List library components
    • Remove libraries
    • Library components
  • Setting up a simulation
• OPICS Multiprocessing
  • Enabling multiprocessing
    • Option 1: Using mp_config
    • Option 2: Using enable_mp
  • Disable multiprocessing
  • Example: Multiple ring resonators coupled to a waveguide
• Network Concatenation

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

Contributors

• 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

next

OPICS Quickstart