# hitaishi2222/photonics_helper architecture

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

- Interactive diagram: https://gitdiagram.com/hitaishi2222/photonics_helper
- Repository: https://github.com/hitaishi2222/photonics_helper

## Overview

Photonics Helper is a scientific Python library for modeling optical pulses, materials, and nonlinear propagation. Its principal workflow is to define physical units and a temporal grid, construct a pulse and fiber, propagate the pulse with a GNLSE solver, then inspect the result. Separate branches cover Raman/material data, polarization and multimode propagation, analytic solutions, inverse design, and pulse diagnostics such as FROG. The graph follows documented capabilities and sampled references; some subsystem links use README evidence because their implementation was not sampled.

Main entry points: [`photonics_helper/gnlse.py`](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/gnlse.py) (GNLSE solver), [`photonics_helper/pulse.py`](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/pulse.py) (Pulse and FROG), [`photonics_helper/raman/spec.py`](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/raman/spec.py) (Raman specifications), [`photonics_helper/raman/explorer.py`](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/raman/explorer.py) (Raman explorer)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_foundations["Physical Foundations"]
  node_units["Units and constants<br/>[base.py]"]
  node_grid["Temporal grid<br/>[grids.py]"]
  node_pulse["Pulse and FROG<br/>[pulse.py]"]
end

subgraph group_propagation["Pulse Propagation"]
  node_fiber["Fiber profiles<br/>[fiber.py]"]
  node_gnlse["GNLSE solver<br/>[gnlse.py]"]
  node_vector["Vector GNLSE<br/>[vector_gnlse.py]"]
  node_multimode["Multimode GNLSE<br/>[multimode_gnlse.py]"]
  node_noise["Propagation noise<br/>[noise.py]"]
  node_phase["Phase matching<br/>[phase_matching.py]"]
end

subgraph group_materials["Materials and Raman"]
  node_materials_db[("Material database<br/>[data.py]")]
  node_material_models["Material models<br/>[materials.py]"]
  node_raman_response["Raman response<br/>[response.py]"]
  node_raman_spec["Raman specifications<br/>[spec.py]"]
end

subgraph group_analysis["Analysis and Design"]
  node_breathers["Breather solutions<br/>[breathers.py]"]
  node_solitons["Soliton analysis<br/>[soliton.py]"]
  node_wave_breaking["Wave breaking<br/>[wave_breaking.py]"]
  node_inverse_design["Inverse design<br/>[inverse_design.py]"]
  node_dbr["DBR simulation<br/>[dbr.py]"]
  node_result["Propagation results<br/>[gnlse.py]"]
end

subgraph group_visualization["Visualization"]
  node_raman_explorer["Raman explorer<br/>[explorer.py]"]
  node_raman_dashboard["Raman dashboard<br/>[dashboard.py]"]
end

node_researcher(("Photonic researcher"))

node_researcher -->|"defines quantities"| node_units
node_researcher -->|"creates pulse"| node_pulse
node_researcher -->|"configures fiber"| node_fiber
node_pulse -->|"uses sampling"| node_grid
node_gnlse -->|"accepts pulse"| node_pulse
node_gnlse -->|"accepts fiber"| node_fiber
node_researcher -->|"runs propagation"| node_gnlse
node_gnlse -->|"produces results"| node_result
node_vector -->|"extends solver"| node_gnlse
node_multimode -->|"extends solver"| node_gnlse
node_gnlse -->|"uses noise"| node_noise
node_gnlse -->|"checks matching"| node_phase
node_material_models -->|"queries data"| node_materials_db
node_raman_response -.->|"uses specifications"| node_raman_spec
node_raman_spec -->|"loads records"| node_materials_db
node_raman_explorer -->|"compares materials"| node_raman_spec
node_raman_dashboard -.->|"presents exploration"| node_raman_explorer
node_researcher -->|"uses solutions"| node_breathers
node_researcher -->|"analyzes solitons"| node_solitons
node_researcher -->|"studies breaking"| node_wave_breaking
node_researcher -->|"designs systems"| node_inverse_design
node_researcher -->|"simulates stacks"| node_dbr
node_researcher -->|"retrieves FROG"| node_pulse

click node_units "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/base.py"
click node_grid "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/core/grids.py"
click node_pulse "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/pulse.py"
click node_fiber "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/fiber.py"
click node_gnlse "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/gnlse.py"
click node_vector "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/vector_gnlse.py"
click node_multimode "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/multimode_gnlse.py"
click node_noise "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/noise.py"
click node_phase "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/phase_matching.py"
click node_materials_db "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/core/data.py"
click node_material_models "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/materials.py"
click node_raman_response "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/raman/response.py"
click node_raman_spec "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/raman/spec.py"
click node_raman_explorer "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/raman/explorer.py"
click node_raman_dashboard "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/raman/dashboard.py"
click node_breathers "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/breathers.py"
click node_solitons "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/soliton.py"
click node_wave_breaking "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/wave_breaking.py"
click node_inverse_design "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/inverse_design.py"
click node_dbr "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/dbr.py"
click node_result "https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/gnlse.py"

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_units,node_grid,node_pulse toneBlue
class node_fiber,node_gnlse,node_vector,node_multimode,node_noise,node_phase toneAmber
class node_materials_db,node_material_models,node_raman_response,node_raman_spec toneMint
class node_breathers,node_solitons,node_wave_breaking,node_inverse_design,node_dbr,node_result toneRose
class node_raman_explorer,node_raman_dashboard,node_researcher toneIndigo
```

## Components

### Physical Foundations

- [Units and constants](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/base.py): `photonics_helper/base.py`
- [Temporal grid](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/core/grids.py): `photonics_helper/core/grids.py`
- [Pulse and FROG](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/pulse.py): `photonics_helper/pulse.py`

### Pulse Propagation

- [Fiber profiles](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/fiber.py): `photonics_helper/fiber.py`
- [GNLSE solver](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/gnlse.py): `photonics_helper/gnlse.py`
- [Vector GNLSE](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/vector_gnlse.py): `photonics_helper/vector_gnlse.py`
- [Multimode GNLSE](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/multimode_gnlse.py): `photonics_helper/multimode_gnlse.py`
- [Propagation noise](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/noise.py): `photonics_helper/noise.py`
- [Phase matching](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/phase_matching.py): `photonics_helper/phase_matching.py`

### Materials and Raman

- [Material database](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/core/data.py): `photonics_helper/core/data.py`
- [Material models](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/materials.py): `photonics_helper/materials.py`
- [Raman response](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/raman/response.py): `photonics_helper/raman/response.py`
- [Raman specifications](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/raman/spec.py): `photonics_helper/raman/spec.py`

### Analysis and Design

- [Breather solutions](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/breathers.py): `photonics_helper/breathers.py`
- [Soliton analysis](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/soliton.py): `photonics_helper/soliton.py`
- [Wave breaking](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/wave_breaking.py): `photonics_helper/wave_breaking.py`
- [Inverse design](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/inverse_design.py): `photonics_helper/inverse_design.py`
- [DBR simulation](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/dbr.py): `photonics_helper/dbr.py`
- [Propagation results](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/gnlse.py): `photonics_helper/gnlse.py`

### Visualization

- [Raman explorer](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/raman/explorer.py): `photonics_helper/raman/explorer.py`
- [Raman dashboard](https://github.com/hitaishi2222/photonics_helper/blob/main/photonics_helper/raman/dashboard.py): `photonics_helper/raman/dashboard.py`

### Other components

- **Photonic researcher**

## Connections

- Photonic researcher → Units and constants: defines quantities
- Photonic researcher → Pulse and FROG: creates pulse
- Photonic researcher → Fiber profiles: configures fiber
- Pulse and FROG → Temporal grid: uses sampling (evidence: `photonics_helper/pulse.py`)
- GNLSE solver → Pulse and FROG: accepts pulse (evidence: `photonics_helper/gnlse.py`)
- GNLSE solver → Fiber profiles: accepts fiber (evidence: `photonics_helper/gnlse.py`)
- Photonic researcher → GNLSE solver: runs propagation
- GNLSE solver → Propagation results: produces results (evidence: `photonics_helper/gnlse.py`)
- Vector GNLSE → GNLSE solver: extends solver (evidence: `photonics_helper/vector_gnlse.py`)
- Multimode GNLSE → GNLSE solver: extends solver (evidence: `photonics_helper/multimode_gnlse.py`)
- GNLSE solver → Propagation noise: uses noise (evidence: `photonics_helper/gnlse.py`)
- GNLSE solver → Phase matching: checks matching (evidence: `photonics_helper/gnlse.py`)
- Material models → Material database: queries data (evidence: `photonics_helper/materials.py`)
- Raman response → Raman specifications: uses specifications
- Raman specifications → Material database: loads records (evidence: `photonics_helper/core/data.py`)
- Raman explorer → Raman specifications: compares materials (evidence: `photonics_helper/raman/explorer.py`)
- Raman dashboard → Raman explorer: presents exploration
- Photonic researcher → Breather solutions: uses solutions
- Photonic researcher → Soliton analysis: analyzes solitons
- Photonic researcher → Wave breaking: studies breaking
- Photonic researcher → Inverse design: designs systems
- Photonic researcher → DBR simulation: simulates stacks
- Photonic researcher → Pulse and FROG: retrieves FROG (evidence: `photonics_helper/pulse.py`)
