API Overview

The package is documented directly from its docstrings. The most useful entry points are:

meanas: top-level package overview
eigensolvers: generic eigenvalue utilities used by the mode solvers
fdfd: frequency-domain operators, sources, PML, solvers, and far-field transforms
waveguides: straight, cylindrical, and 3D waveguide mode helpers
fdtd: timestepping, CPML, energy/flux helpers, and phasor extraction
fdmath: shared discrete operators, vectorization helpers, and derivation background

The waveguide and FDTD pages are the best places to start if you want the mathematical derivations rather than just the callable reference.