2026-04-18 15:05:35 -07:00
|
|
|
# meanas
|
|
|
|
|
|
|
|
|
|
`meanas` is a Python package for finite-difference electromagnetic simulation.
|
|
|
|
|
It combines:
|
|
|
|
|
|
|
|
|
|
- `meanas.fdfd` for frequency-domain operators, sources, waveguide modes, and SCPML
|
|
|
|
|
- `meanas.fdtd` for Yee-grid timestepping, CPML, energy/flux accounting, and phasor extraction
|
|
|
|
|
- `meanas.fdmath` for the shared discrete operators and derivations underneath both solvers
|
|
|
|
|
|
|
|
|
|
This documentation is built directly from the package docstrings. The API pages
|
|
|
|
|
are the source of truth for the mathematical derivations and calling
|
|
|
|
|
conventions.
|
|
|
|
|
|
2026-04-19 00:50:22 -07:00
|
|
|
## Examples and API Map
|
2026-04-18 15:05:35 -07:00
|
|
|
|
2026-04-19 00:50:22 -07:00
|
|
|
For most users, the tracked examples under `examples/` are the right entry
|
|
|
|
|
point. They show the intended combinations of tools for solving complete
|
|
|
|
|
problems.
|
|
|
|
|
|
|
|
|
|
The API pages are better read as a toolbox map and derivation reference:
|
|
|
|
|
|
|
|
|
|
- Use the [FDTD API](api/fdtd.md) for time-domain stepping, CPML, and phasor
|
|
|
|
|
extraction.
|
|
|
|
|
- Use the [FDFD API](api/fdfd.md) for driven frequency-domain solves and sparse
|
|
|
|
|
operator algebra.
|
|
|
|
|
- Use the [Waveguide API](api/waveguides.md) for mode solving, port sources,
|
|
|
|
|
and overlap windows.
|
|
|
|
|
- Use the [fdmath API](api/fdmath.md) for the lower-level finite-difference
|
|
|
|
|
operators and the shared discrete derivations underneath both solvers.
|
2026-04-18 15:05:35 -07:00
|
|
|
|
|
|
|
|
## Build outputs
|
|
|
|
|
|
|
|
|
|
The docs build generates two HTML views from the same source:
|
|
|
|
|
|
|
|
|
|
- a normal multi-page site
|
|
|
|
|
- a print-oriented combined page under `site/print_page/`
|
|
|
|
|
|
|
|
|
|
If `htmlark` is installed, `./make_docs.sh` also writes a fully inlined
|
|
|
|
|
`site/standalone.html`.
|
