# lukasc-ubc/siliconphotonicsdesign architecture

> Architecture diagram of the GitHub repository lukasc-ubc/siliconphotonicsdesign, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/lukasc-ubc/siliconphotonicsdesign
- Repository: https://github.com/lukasc-ubc/siliconphotonicsdesign

## Overview

This repository is a collection of textbook example scripts for silicon-photonics design, not a single application. Its broad workflow is an engineer using chapter examples to model devices and study their behavior; the README identifies Lumerical, MATLAB, and Mentor Graphics as the script environments. The sampled Tidy3D example specifically builds a waveguide, configures a mode solver, and computes effective-index, profile, dispersion, and sweep results. Other chapter branches are represented by their tree paths and names; their internal call relationships were not inspected.

Main entry points: [`siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py`](https://github.com/lukasc-ubc/siliconphotonicsdesign/blob/master/siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py) (Mode Solver Setup), [`siliconphotonicsdesign_book_scripts/ch3`](https://github.com/lukasc-ubc/siliconphotonicsdesign/tree/master/siliconphotonicsdesign_book_scripts/ch3) (Waveguide Examples), [`siliconphotonicsdesign_book_scripts/ch4`](https://github.com/lukasc-ubc/siliconphotonicsdesign/tree/master/siliconphotonicsdesign_book_scripts/ch4) (Passive Devices), [`siliconphotonicsdesign_book_scripts/ch5`](https://github.com/lukasc-ubc/siliconphotonicsdesign/tree/master/siliconphotonicsdesign_book_scripts/ch5) (Couplers and Gratings)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_waveguides["Waveguides"]
  node_waveguide_examples["Waveguide Examples"]
  node_tidy_geometry["Waveguide Geometry<br/>[waveguide_mode.py]"]
  node_tidy_solver["Mode Solver Setup<br/>[waveguide_mode.py]"]
  node_tidy_analysis["Mode Analysis<br/>[waveguide_mode.py]"]
  node_tidy_sweeps["Convergence and Sweeps<br/>[waveguide_mode.py]"]
end

subgraph group_passive["Passive Devices"]
  node_passive_examples["Passive Devices"]
end

subgraph group_coupling["Optical Coupling"]
  node_coupler_examples["Couplers and Gratings"]
end

subgraph group_active["Active Devices"]
  node_modulator_examples["Modulators"]
  node_detector_examples["Photodetectors"]
end

subgraph group_characterization["Device Characterization"]
  node_system_examples["System Characterization"]
end

node_engineer(("Engineer"))

node_engineer -->|"uses examples"| node_waveguide_examples
node_engineer -->|"uses examples"| node_passive_examples
node_engineer -->|"uses examples"| node_coupler_examples
node_engineer -->|"uses examples"| node_modulator_examples
node_engineer -->|"uses examples"| node_detector_examples
node_engineer -->|"uses examples"| node_system_examples
node_tidy_geometry -->|"configures solver"| node_tidy_solver
node_tidy_solver -->|"solves modes"| node_tidy_analysis
node_tidy_analysis -->|"feeds sweeps"| node_tidy_sweeps

click node_waveguide_examples "https://github.com/lukasc-ubc/siliconphotonicsdesign/tree/master/siliconphotonicsdesign_book_scripts/ch3"
click node_tidy_geometry "https://github.com/lukasc-ubc/siliconphotonicsdesign/blob/master/siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py"
click node_tidy_solver "https://github.com/lukasc-ubc/siliconphotonicsdesign/blob/master/siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py"
click node_tidy_analysis "https://github.com/lukasc-ubc/siliconphotonicsdesign/blob/master/siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py"
click node_tidy_sweeps "https://github.com/lukasc-ubc/siliconphotonicsdesign/blob/master/siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py"
click node_passive_examples "https://github.com/lukasc-ubc/siliconphotonicsdesign/tree/master/siliconphotonicsdesign_book_scripts/ch4"
click node_coupler_examples "https://github.com/lukasc-ubc/siliconphotonicsdesign/tree/master/siliconphotonicsdesign_book_scripts/ch5"
click node_modulator_examples "https://github.com/lukasc-ubc/siliconphotonicsdesign/tree/master/siliconphotonicsdesign_book_scripts/ch6"
click node_detector_examples "https://github.com/lukasc-ubc/siliconphotonicsdesign/tree/master/siliconphotonicsdesign_book_scripts/ch7"
click node_system_examples "https://github.com/lukasc-ubc/siliconphotonicsdesign/tree/master/siliconphotonicsdesign_book_scripts/ch9"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_waveguide_examples,node_tidy_geometry,node_tidy_solver,node_tidy_analysis,node_tidy_sweeps toneBlue
class node_passive_examples toneAmber
class node_coupler_examples toneMint
class node_modulator_examples,node_detector_examples toneRose
class node_system_examples,node_engineer toneIndigo
```

## Components

### Waveguides

- [Waveguide Examples](https://github.com/lukasc-ubc/siliconphotonicsdesign/tree/master/siliconphotonicsdesign_book_scripts/ch3): `siliconphotonicsdesign_book_scripts/ch3`
- [Waveguide Geometry](https://github.com/lukasc-ubc/siliconphotonicsdesign/blob/master/siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py): `siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py`
- [Mode Solver Setup](https://github.com/lukasc-ubc/siliconphotonicsdesign/blob/master/siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py): `siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py`
- [Mode Analysis](https://github.com/lukasc-ubc/siliconphotonicsdesign/blob/master/siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py): `siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py`
- [Convergence and Sweeps](https://github.com/lukasc-ubc/siliconphotonicsdesign/blob/master/siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py): `siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py`

### Passive Devices

- [Passive Devices](https://github.com/lukasc-ubc/siliconphotonicsdesign/tree/master/siliconphotonicsdesign_book_scripts/ch4): `siliconphotonicsdesign_book_scripts/ch4`

### Optical Coupling

- [Couplers and Gratings](https://github.com/lukasc-ubc/siliconphotonicsdesign/tree/master/siliconphotonicsdesign_book_scripts/ch5): `siliconphotonicsdesign_book_scripts/ch5`

### Active Devices

- [Modulators](https://github.com/lukasc-ubc/siliconphotonicsdesign/tree/master/siliconphotonicsdesign_book_scripts/ch6): `siliconphotonicsdesign_book_scripts/ch6`
- [Photodetectors](https://github.com/lukasc-ubc/siliconphotonicsdesign/tree/master/siliconphotonicsdesign_book_scripts/ch7): `siliconphotonicsdesign_book_scripts/ch7`

### Device Characterization

- [System Characterization](https://github.com/lukasc-ubc/siliconphotonicsdesign/tree/master/siliconphotonicsdesign_book_scripts/ch9): `siliconphotonicsdesign_book_scripts/ch9`

### Other components

- **Engineer**

## Connections

- Engineer → Waveguide Examples: uses examples (evidence: `README.md`)
- Engineer → Passive Devices: uses examples (evidence: `README.md`)
- Engineer → Couplers and Gratings: uses examples (evidence: `README.md`)
- Engineer → Modulators: uses examples (evidence: `README.md`)
- Engineer → Photodetectors: uses examples (evidence: `README.md`)
- Engineer → System Characterization: uses examples (evidence: `README.md`)
- Waveguide Geometry → Mode Solver Setup: configures solver (evidence: `siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py`)
- Mode Solver Setup → Mode Analysis: solves modes (evidence: `siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py`)
- Mode Analysis → Convergence and Sweeps: feeds sweeps (evidence: `siliconphotonicsdesign_book_scripts/ch3/tidy3d/waveguide_mode.py`)
