Publish docs for local build

This commit is contained in:
Forgejo Actions 2026-04-19 16:40:30 -07:00
commit 693e3af8fa
9 changed files with 2042 additions and 817 deletions

View file

@ -647,10 +647,26 @@ conventions.</p>
<p>For most users, the tracked examples under <code>examples/</code> are the right entry
point. They show the intended combinations of tools for solving complete
problems.</p>
<p>Relevant starting examples:</p>
<ul>
<li><code>examples/fdtd.py</code> for broadband pulse excitation and phasor extraction</li>
<li><code>examples/waveguide.py</code> for guided phasor-domain FDTD/FDFD comparison</li>
<li><code>examples/waveguide_real.py</code> for real-valued continuous-wave FDTD compared
against real fields reconstructed from an FDFD solution, including guided-core,
mode-weighted, and guided-mode / residual comparisons</li>
<li><code>examples/fdfd.py</code> for direct frequency-domain waveguide excitation</li>
</ul>
<p>For solver equivalence, prefer the phasor-based examples first. They compare
the extracted <code>+\omega</code> content of the FDTD run directly against the FDFD
solution and are the main accuracy benchmarks in the test suite.</p>
<p><code>examples/waveguide_real.py</code> answers a different, stricter question: how well a
late raw real snapshot matches <code>Re(E_\omega e^{i\omega t})</code> on a monitor plane.
That diagnostic is useful, but it also includes orthogonal residual structure
that the phasor comparison intentionally filters out.</p>
<p>The API pages are better read as a toolbox map and derivation reference:</p>
<ul>
<li>Use the <a href="api/fdtd/">FDTD API</a> for time-domain stepping, CPML, and phasor
extraction.</li>
<li>Use the <a href="api/fdtd/">FDTD API</a> for time-domain stepping, CPML, phasor
extraction, and real-field reconstruction from FDFD phasors.</li>
<li>Use the <a href="api/fdfd/">FDFD API</a> for driven frequency-domain solves and sparse
operator algebra.</li>
<li>Use the <a href="api/waveguides/">Waveguide API</a> for mode solving, port sources,