API Reference¶

The public surface, grouped by module — one page per module. Docstrings are the source of truth and are rendered with mkdocstrings (numpydoc style).

Section	Page
Units and constants	`base`
Pulse envelopes & grids	`pulse`
Fiber & propagation constants	`fiber`
GNLSE	`gnlse`
Phase-matching diagnostics (χ³)	`phase_matching`
χ⁽²⁾ nonlinear optics (SHG / SFG / DFG)	`chi2`
Raman scattering	`raman`
Soliton analysis	`soliton`
Breathers and exact solutions	`breathers`
Noise sources	`noise`
Optical wave breaking	`wave_breaking`
Structured light (LG / OAM)	`structured`
DBR / TMM	`dbr`
Materials & n/k database	`materials`
Phonons	`phonon`
FFT backends	`_fftw`
Unified dashboard	`dashboard`