photonhub 0.1.0__tar.gz

photonhub-0.1.0/.gitignore

@@ -0,0 +1,102 @@
+# Build trees
+build/
+build-*/
+!desktop/electron/build-hooks/
+cmake-build-*/
+
+# desktop viz dev: local result bundle generated for testing serve-viz
+.devbundle/
+
+# Native desktop packaging outputs and downloaded/frozen toolchains.  The
+# packaging recipes, locks, and verifier remain committed under this directory.
+/desktop/packaging/.cache/
+/desktop/packaging/.work/
+/desktop/packaging/artifacts/
+/desktop/packaging/dist/
+/desktop/packaging/stage/
+
+# Documentation site build output. docs-site/build.sh renders into
+# website/docs/ so the existing leapfield Firebase site serves it at
+# /docs; the rendered HTML is generated and never committed.
+website/docs/
+
+# Python
+.venv/
+venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+.pytest_cache/
+.ruff_cache/
+
+# Outputs / artifacts
+out/
+*.bin
+*.hdf5
+*.h5
+benchmarks/results/local/
+# generated acceptance reports (per-component PDF + npz + run log); CPU run ->
+# reports/, a --device gpu run -> reports_gpu/. Regenerated by make_reports.py.
+benchmarks/acceptance/reports/
+benchmarks/acceptance/reports_*/
+# Rented-GPU session bundles (tools/gpu_session.sh); scp home, commit only the
+# results/*.jsonl under benchmarks/results/, never the raw logs/tarballs.
+artifacts/
+
+# Editors / OS
+.DS_Store
+.idea/
+.vscode/
+*.swp
+
+# Claude scratch
+.claude/*.local.json
+/.claude/launch.json
+/.claude/worktrees/
+
+# Local agent/worktree state (never part of the product source tree)
+/.codex/
+/.worktrees/
+
+# Local paper library and duplicate presentation export
+/literature/
+/*.pdf
+/presentation/PhotonHub Intro.html
+
+# benchmark run artifacts
+benchmarks/waveguide/results.npz
+# Component benchmark raw runs (sim.json echo + manifest + monitor .bin DFT
+# fields): reproducible, gitignored. The curated sim/ph.json, results/*.json,
+# compare.json and compare.png ARE committed.
+benchmarks/components/*/run/
+# GDS-import benchmark raw runs (same convention as components/); the curated
+# gds/, sim/ph.json, results/ph_cpu.json, spectrum.png ARE committed.
+benchmarks/gds/*/run/
+# Raw field arrays (reproducible from a run); the field_z0.png / field_gpu25.png
+# viz IS committed.
+benchmarks/gds/*/results/*.npz
+# §16.6 subpixel A/B/C sims + results (off/diagonal/full off-diagonal tensor):
+# regenerated by gen_subpixel_compare.py / make_gpu_report.py, so gitignored.
+benchmarks/gds/*/sim/ph_gpu25_nd_*.json
+benchmarks/gds/*/results/ph_gpu25_nd_*.json
+# CPU subpixel A/B/C run logs (transient); the report .json + .pdf ARE committed.
+benchmarks/gds/report/cpu_run*.log
+# Subpixel convergence benchmark raw outputs (reproducible from the script); the
+# script + README + convergence.png ARE committed.
+benchmarks/subpixel/results.json
+benchmarks/subpixel/run.log
+
+# Bent-mode Tidy3D reference: user-generated (needs an API key) + its preview.
+# subpixel-parity run logs (transient); the .json/.md/.png ARE committed.
+benchmarks/tidy3d/refs/*/subpixel_parity_run.log
+# The PhotonHub side (refs/bent_modes/photonhub.json) IS committed.
+benchmarks/tidy3d/refs/bent_modes/tidy3d.json
+benchmarks/tidy3d/refs/bent_modes/tidy3d_crosssection.png
+# co-location comparison run log (transient); the .json/.pdf ARE committed.
+benchmarks/gds/report/colocation_run.log
+.devrun/
+
+# Local review/render scratch (never product source or evidence)
+/tmp/
+website/.firebase/

photonhub-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Zhetao J.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

photonhub-0.1.0/PKG-INFO

@@ -0,0 +1,243 @@
+Metadata-Version: 2.5
+Name: photonhub
+Version: 0.1.0
+Summary: Python client for the PhotonHub GPU FDTD photonics solver
+Project-URL: Homepage, https://leapfield.app/
+Project-URL: Repository, https://github.com/Leapfield/photonhub-sdk
+Project-URL: Beta access and support, https://leapfield.app/#request
+Author: LeapField
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: FDTD,electromagnetics,photonics,simulation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.11
+Requires-Dist: certifi
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pydantic>=2.6
+Requires-Dist: scipy
+Requires-Dist: xarray
+Provides-Extra: app
+Requires-Dist: fastapi; extra == 'app'
+Requires-Dist: gdstk; extra == 'app'
+Requires-Dist: h5py; extra == 'app'
+Requires-Dist: mcp<2,>=1; extra == 'app'
+Requires-Dist: plotly; extra == 'app'
+Requires-Dist: uvicorn; extra == 'app'
+Provides-Extra: gds
+Requires-Dist: gdstk; extra == 'gds'
+Provides-Extra: hdf5
+Requires-Dist: h5py; extra == 'hdf5'
+Provides-Extra: mcp
+Requires-Dist: mcp<2,>=1; extra == 'mcp'
+Provides-Extra: notebook
+Requires-Dist: nbformat; extra == 'notebook'
+Provides-Extra: replicate
+Requires-Dist: pyyaml; extra == 'replicate'
+Provides-Extra: server
+Requires-Dist: fastapi; extra == 'server'
+Requires-Dist: uvicorn; extra == 'server'
+Provides-Extra: test
+Requires-Dist: fastapi; extra == 'test'
+Requires-Dist: gdstk; extra == 'test'
+Requires-Dist: h5py; extra == 'test'
+Requires-Dist: httpx; extra == 'test'
+Requires-Dist: ipywidgets; extra == 'test'
+Requires-Dist: mcp<2,>=1; extra == 'test'
+Requires-Dist: nbformat; extra == 'test'
+Requires-Dist: plotly; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pyyaml; extra == 'test'
+Requires-Dist: ruff; extra == 'test'
+Requires-Dist: uvicorn; extra == 'test'
+Provides-Extra: viz
+Requires-Dist: ipywidgets; extra == 'viz'
+Requires-Dist: plotly; extra == 'viz'
+Description-Content-Type: text/markdown
+
+# photonhub
+
+Python client for the PhotonHub FDTD solver. The pydantic models in
+`photonhub.components` are the single source of truth for the simulation
+JSON wire format; the published simulation schema is generated from them via
+`python -m photonhub.schema emit`.
+
+## Install
+
+Python 3.11+:
+
+```sh
+python -m pip install "photonhub @ git+https://github.com/Leapfield/photonhub-sdk"
+```
+
+(From a monorepo checkout: `python -m pip install ./photonhub`.)
+
+That installs the full scripting client: build simulations, estimate cost,
+run on the **cloud GPU** (`ph.web.run(sim)` with your beta API key), and read
+results — no compiler, no engine build. **Local** runs (`ph.run_local`) also
+need the `phsolver` engine binary, which pip does not ship: the desktop
+Workbench install bundles one (point `$PHOTONHUB_SOLVER` at it or put it on
+`PATH`), and developers with the monorepo build it with
+`cmake -S engine -B build && cmake --build build`.
+
+Optional extras: `photonhub[viz]` (interactive/3D plots), `[gds]` (GDSII
+import/export), `[hdf5]` (HDF5 result export), `[replicate]`, `[notebook]`,
+and the service extras below.
+
+```python
+import photonhub as ph
+
+sim = ph.Simulation(
+    size_um=(4.0, 4.0, 4.0),
+    grid=ph.UniformGridSpec(dl_um=0.05),
+    run=ph.RunSpec(run_time_s=8.0e-14),
+    sources=[
+        ph.PointDipole(
+            center_um=(2.0, 2.0, 2.0),
+            polarization="Ez",
+            source_time=ph.GaussianPulse(freq0_hz=1.934e14, fwidth_hz=4.0e13),
+        )
+    ],
+    monitors=[
+        ph.FieldTimeMonitor(name="probe", center_um=(3.0, 2.0, 2.0), fields=["Ez"]),
+        ph.FieldSnapshotMonitor(name="final", fields=["Ex", "Ey", "Ez"]),
+    ],
+)
+
+data = ph.run_local(sim)        # finds phsolver, runs it, parses outputs
+probe = data["probe"]           # xarray.DataArray, dims ('t', 'component')
+```
+
+Optional command-line services are kept out of the base SDK dependency set:
+
+```sh
+python -m pip install 'photonhub[mcp]'
+photonhub-mcp                    # optionally pass a result directory to preload
+
+python -m pip install 'photonhub[server]'
+photonhub-serve-viz              # local result/preview HTTP service
+```
+
+The `photonhub[app]` extra includes both service dependency sets plus the
+Workbench file-format integrations.
+
+## See your simulation before you run it
+
+Every `Simulation` plots itself — geometry, sources, monitors, PML, and the
+**permittivity the solver actually meshes** — with matplotlib (built in; plotly
+for 3D). `grid=True` overlays the Yee cell edges so you can check resolution:
+
+```python
+sim.plot(z=0.11)                  # scene cross-section
+sim.plot_eps(z=0.11, grid=True)   # rasterized ε + the Yee mesh overlay
+sim.plot_3d()                     # interactive 3D  (pip install photonhub[viz])
+```
+
+## What you can do today
+
+Shipped surface as of schema **v1.20.0-alpha.1** (validated dispersive solver
+core — multi-pole Lorentz + Drude ADE with a fitted metals library (Au/Ag/Cu/Al)
+and PEC structures, with recorded MI300X CPU↔GPU equivalence for the pre-1.18
+surface under the numerical contract's tolerances — plus full-vector mode
+injection, GDS import (`ph.import_gds`), adjoint gradients, and the silicon-PIC
+MVP):
+
+- **Run a simulation:** `ph.run_local(sim)` (subprocess + file protocol;
+  `device="cpu"|"gpu"|"gpu:N"`), `ph.run_async(sim)` and `ph.Batch(...)` for many
+  sims in flight.
+- **Know the cost first:** `sim.cost_estimate()` (or `ph.estimate_cost(sim)`)
+  returns a dollar estimate
+  from an overridable Tcell-step planning rate *before* you press run; the
+  default is an estimator input, not a production billing commitment.
+- **Geometry:** `Box`, `Sphere`, `Cylinder` (full, or an annular sector / ring
+  via `inner_radius_um` + `angle_start` / `angle_stop`), and `PolySlab` (an
+  extruded polygon — e.g. a taper).
+- **Sources:** `PointDipole`, `PlaneWave` (normal-incidence TF/SF; oblique
+  via `Simulation.with_oblique_plane_wave` + Bloch boundaries, schema 1.18),
+  the closed `TfsfBox` scattering box (single-run cross-sections with PML on
+  all sides), and the recommended `mode_launch` waveguide-mode builder — all
+  driven by a `GaussianPulse` or a steady-state `CW` carrier. The
+  `ModeSource` wire type remains for legacy scalar and continuous-adjoint
+  compatibility.
+- **Monitors:** `FieldTimeMonitor`, `FieldSnapshotMonitor`, `FieldDftMonitor`,
+  and `FluxMonitor` — fp64 DFT field and flux power. A DFT plane may carry the
+  optional `ModePort` authoring recipe; the engine strictly validates and then
+  ignores that metadata while recording the same raw fields, and result
+  post-processing performs the requested modal projection. Workbench keeps one
+  shared wavelength sweep across ports; port planes/windows stay outside
+  PML/absorber cells; and preflight requires one downstream driven port linked
+  to the first wire-order normalization source with no other active excitation,
+  so an unevaluable S-column is rejected before the time-domain run.
+- **Component library:** `ph.library.straight / bend / taper / crossing /
+  coupler / ring` — each returns a `Component` (structures + ports) in ~one line.
+- **Material library:** `ph.materials` — 16 literature materials (cSi, SiO2,
+  Si3N4, GaAs, InP, Ge, LiNbO3, sapphire, AlN, TiO2, MgF2, CaF2, PMMA, ...)
+  with cited dispersion data and validity ranges. `cSi.medium(1.55)` freezes
+  the index at one wavelength; `cSi.medium(band_um=(1.5, 1.6))` least-squares
+  fits the engine's single Lorentz pole over the band (Courant-safe pole
+  placement, ≤1e-4 index error over 100 nm). Bring measured ellipsometry data
+  via `materials.Material.from_nk_data(...)`.
+- **Mode-resolved transmission:** the recommended `photonhub.plugins` pipeline —
+  `solve_yee_mode` → `mode_launch` → `mode_monitor` →
+  `transmission(out, in, data)` — returns `{freq_hz: T}`. Use
+  `solve_yee_mode_bank` / `solve_modes_by_freq` for a broadband launch and readout;
+  the legacy `ModeSolver` / `mode_source` path remains for scalar and adjoint
+  compatibility. Full complex multiport S-matrices:
+  `plugins.smatrix` (`SPort` + `assemble_smatrix`, one run per driven port —
+  the analogue of Tidy3D's ComponentModeler).
+- **Meshing:** `UniformGridSpec`, or `GradedGridSpec` + `auto_grid` for a
+  cells-per-λ graded mesh; `MeshOverride` (Tidy3D `MeshOverrideStructure`) forces
+  a target spacing inside a geometry regardless of material —
+  `sim.with_mesh_overrides(MeshOverride(geometry=Box(...), dl_um=(0.02,0.02,None)))`.
+  Graded meshes run on CPU, single GPU, and multi-GPU with PML/absorber,
+  dispersive media, DFT/flux monitors, and plane-wave/mode sources. The one
+  unsupported combination is graded + `subpixel_method="tensor_full"`.
+- **Mode solving:** the FDE plugins provide the lightweight semi-vectorial
+  `ModeSolver` and the full-vector `VectorModeSolver`, including bent/leaky
+  modes with complex `n_eff` and bend-loss readout.
+- **Visualization:** `Simulation.plot` / `plot_eps` (draws Box / Sphere /
+  Cylinder / PolySlab; `grid=True` overlays the Yee mesh) / `plot_3d`,
+  `SimulationData.plot_field`, and the module-level `photonhub.viz.plot_mode`
+  (FDE mode heatmap) and `photonhub.viz.plot_spectrum` (`T` vs λ).
+- **Export:** HDF5 converter for the parsed results.
+- **Correctness aids:** pydantic models reject structural errors at
+  construction, the capability manifest catches client/engine drift, and
+  `phsolver validate` is authoritative for grid/device constraints. Subpixel
+  smoothing supports Box / Sphere / Cylinder / PolySlab; non-dispersive scenes
+  default to contour smoothing, while dispersive scenes default off unless the
+  user opts in.
+
+### Limits (today)
+
+This is a validated **dispersive** solver core plus the silicon-PIC MVP:
+
+- Dispersion is **multi-pole ADE** — up to 6 Lorentz + Drude poles per medium
+  (metals/plasmonics; numerical definition in `engine/NUMERICS.md` §19; the
+  single-pole paths are in the recorded MI300X equivalence suite under §8
+  tolerances, the multi-pole/Drude scenes await their first hardware run) on
+  top of relative permittivity + Ohmic conductivity; a passivity-enforced
+  CCPR fitter and anisotropic poles are still open. Explicit
+  subpixel + Lorentz runs are supported and equivalence-tested, but the client
+  keeps their construction default off and warns callers to use the stabilized
+  PML profile.
+- S-matrix assembly (`plugins.smatrix`) costs **one simulation per driven
+  port** — there is no single-run multiport solve.
+
+Net: shapes go in and **mode-resolved transmission** comes out — solve the
+eigenmode, inject it with `mode_launch`, ratio two `mode_monitor` planes, and plot
+`T(λ)`; or assemble the full S-matrix with `plugins.smatrix`.
+
+## Learn more
+
+- **[API documentation and guides](https://leapfield.app/docs/)** — the full reference for
+  every public symbol in this package, plus install and quickstart guides.
+- [PhotonHub product overview](https://leapfield.app/#product)
+- [Request beta access or support](https://leapfield.app/#request)
+
+The project source tree also includes an end-to-end quickstart, examples index,
+and **twenty-six-notebook** gallery.