jan/meanas
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

[docs] high level doc updates

Browse source
This commit is contained in:
Forgejo Actions 2026-04-19 00:50:22 -07:00
commit 318c43d62d
3 changed files with 24 additions and 55 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/index.md
View file

@ -11,16 +11,22 @@ This documentation is built directly from the package docstrings. The API pages
are the source of truth for the mathematical derivations and calling
conventions.
## Recommended starting points
## Examples and API Map
- Use the [FDTD API](api/fdtd.md) when you need time-domain stepping, CPML, or
phasor extraction.
- Use the [FDFD API](api/fdfd.md) when you need driven frequency-domain solves
or operator algebra.
- Use the [Waveguide API](api/waveguides.md) for mode solving, port sources, and
overlap windows.
- Use the [fdmath API](api/fdmath.md) when you need the lower-level finite-difference
operators or the derivation background shared across the package.
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.
## Build outputs