wavebit 0.0.1__tar.gz → 0.0.2__tar.gz

wavebit-0.0.2/LICENSE

@@ -0,0 +1,311 @@
+                                 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
+
+   Copyright 2026 FieldAlgo
+
+   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.
+
+   ---
+   This software is derived from 'meent' (https://github.com/kc-ml2/meent),
+   Copyright (c) 2022 ML2, originally licensed under the MIT License.
+   The MIT License requires that its copyright notice and permission notice
+   be retained; both are reproduced in full in the file LICENSE.meent.
+
+   ---
+   This software also contains code ported from 'fmmax'
+   (https://github.com/facebookresearch/fmmax), Copyright (c) 2023 Meta Research,
+   licensed under the MIT License: the eigendecomposition gradient in
+   src/wavebit/_common/backend.py is a port of `_eig_bwd` from that project's
+   src/fmmax/utils.py. The MIT License requires that its copyright notice and
+   permission notice be retained; both are reproduced in full in the file
+   LICENSE.fmmax.
+
+   fmmax's maintained fork (https://github.com/invrs-io/fmmax) carries the same
+   function in src/fmmax/eig.py and re-states its copyright as 'Copyright: 2025
+   invrs.io LLC', under the same MIT terms. Which of the two the port was taken
+   from is not recorded, so both notices are stated here. LICENSE.fmmax itself is
+   kept as the verbatim upstream text and nothing else, so that licence scanners
+   identify it as MIT -- a note appended there is 29% of MIT's short body and
+   drops the file below the match threshold GitHub's `licensee` uses.
+
+   ---
+   The Li-rule Fourier factorization of rasters in
+   src/wavebit/rcwa/_engine/factorization.py was rewritten on 2026-09-25 from
+   L. Li's published factorization rules (J. Opt. Soc. Am. A 13, 1870 (1996);
+   14, 2758 (1997)): li_conv_matrices, li_conv_matrices_integrated and the
+   helpers written with them, the bodies of fourier2d_piecewise_constant,
+   fourier2d_pointwise and fourier2d_integrated, and the Li parts of
+   to_conv_mat_raster_sampled and to_conv_mat_raster_integrated. The implementer
+   of that rewrite did not consult RETICOLO's or meent's source or the bodies of
+   the functions it replaced. compression_indices and compress_cell were then
+   reimplemented by an implementer working from a written specification of what
+   they return, in a copy of this repository without its history or the earlier
+   bodies; the specification's author had seen the earlier functions and
+   RETICOLO's ret2li. The other Li factorizations run on the rewrite as well:
+   the Cartesian shape path (src/wavebit/rcwa/_engine/rectilinear.py) through
+   fourier2d_integrated, and the tensor path's row transform
+   (src/wavebit/rcwa/_engine/tensor_li.py, added 2026-09-24), which called the
+   earlier helpers directly until it was moved onto the rewritten series. That
+   move, and _row_dft, which restates the documented rule of _normalized_row_fft
+   (a JAX workaround added beside _fourier2d_grid on 2026-09-24 and deleted with
+   it), were written by an implementer working from written specifications whose
+   authors had seen the earlier bodies. The rewritten code still calls helpers
+   kept from before it, written in this repository in August 2026:
+   _pixel_correction, _half_pixel_phase and _inverse_axes. It also calls
+   _circulant_index, which came with the 2026-08-03 single-source port of
+   meent's dfs2d and was rewritten from its definition on 2026-09-26 by an
+   implementer who had not read the earlier body. The commit messages of those
+   dates, and of later changes, record how.
+
+   The rewritten builders' default nesting ('fixed') corresponds to the
+   default, parm.res1.li = 1, of 'RETICOLO', the grating software of J.P.
+   Hugonin and P. Lalanne (Institut d'Optique/CNRS): J.P. Hugonin and P.
+   Lalanne, "RETICOLO software for grating analysis", Institut d'Optique,
+   Orsay, France (2005), arXiv:2101.00901. Their 'symmetric' nesting
+   corresponds to RETICOLO's parm.res1.li = 0.
+
+   Earlier versions of those functions remain in this repository's history, with
+   the helpers deleted alongside them (_fourier2d_grid, _fourier1d_integrated,
+   _wrap and _circulant_gather); that history includes meent's own, from 2022.
+   The Fourier builders descend from meent's dfs2d and cfs2d, written in July
+   2024 with reference to the MATLAB source of RETICOLO V9, following its
+   ret2li (in retcouche.m), retf.m and rettoeplitz.m; compression_indices and
+   compress_cell were split from meent's cell_compression (2022). meent's code
+   names RETICOLO elsewhere in that history too: fft_piecewise_constant was
+   marked "reference: reticolo" from 2023-02 to 2024-06, and a commented-out
+   dfs2d_debug in meent/on_numpy/emsolver/fourier_analysis.py, added on
+   2024-07-19, is described as "algorithm from reticolo", as it still is in
+   meent's own repository (commit bae2802). Checked on 2026-09-25 against
+   RETICOLO's Zenodo records and the packages themselves: retcouche.m, retf.m
+   and rettoeplitz.m are byte-identical in V9
+   (https://zenodo.org/records/4419063, 2021), in its revision V9a
+   (https://zenodo.org/records/5905381, 2022) and in V10
+   (https://doi.org/10.5281/zenodo.14631951, January 2025). The V9 and V9a
+   records declare no licence; the V10 record states CC BY 4.0. No package
+   carries a licence file or licence text in its source. Each package's
+   documentation states "copyright (c) 2005 Institut d'Optique/CNRS" and
+   requires that publications and reports cite the reference above; V10's also
+   calls RETICOLO a freeware. The V10 record also names itself a new version
+   of V9 (isNewVersionOf 10.5281/zenodo.4419063).
+
+   Those earlier versions, and the meent code named above, are used under the
+   Creative Commons Attribution 4.0 International licence (CC BY 4.0) that the
+   V10 record states. They were modified: written in Python, first in meent
+   (https://github.com/kc-ml2/meent) and then in this repository, with
+   reference to RETICOLO's MATLAB source, and the earlier versions have since
+   been replaced by the rewrite described above. Attribution:
+
+       RETICOLO, by J.P. Hugonin and P. Lalanne
+       copyright (c) 2005 Institut d'Optique/CNRS
+       Material: https://doi.org/10.5281/zenodo.14631951
+       Citation: arXiv:2101.00901
+       Licence: CC BY 4.0, https://creativecommons.org/licenses/by/4.0/
+
+   Section 5 of that licence (Disclaimer of Warranties and Limitation of
+   Liability) applies to that material. RETICOLO itself is not part of this
+   software; the comparisons in tests/references/ call a separately installed
+   copy, and one bridge script, tests/references/interface/reti_aniso.m, lays
+   out its calls after RETICOLO's example exemple_V9_0D_anisotrope.m.
+   tests/references/README.md records the check.
+
+   ---
+   From 2022-09-20 to 2026-08-03 this repository's history carried scattering-
+   matrix helpers whose file header states that "many codes for scattering
+   matrix method are from" the 'Rigorous-Coupled-Wave-Analysis' package of
+   Nathan Zhao (Stanford University),
+   https://github.com/zhaonat/Rigorous-Coupled-Wave-Analysis, reached through
+   the fork https://github.com/yonghakim/zhaonat-rcwa: meent/integ/smm_util.py
+   and meent/integ/scattering_method.py, later fieldwave/on_numpy/,
+   on_jax/ and on_torch/emsolver/smm_util.py and scattering_method.py. That
+   package is licensed under the MIT License; its LICENSE file carries the MIT
+   text under a template copyright line ("Copyright (c) 2018 The Python
+   Packaging Authority"), checked on 2026-10-14. The MIT License requires that
+   its copyright notice and permission notice be retained, so this notice
+   records the origin for the history that still contains those files. They
+   were deleted on 2026-08-03 (commit 244cb819, "delete the triplicated
+   transfer/convolution/scattering modules") and nothing in the current tree
+   derives from them.

wavebit-0.0.2/LICENSE.fmmax

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Meta Research
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

wavebit-0.0.2/LICENSE.meent

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 ML2
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

wavebit-0.0.2/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.4
+Name: wavebit
+Version: 0.0.2
+Summary: Differentiable electromagnetic simulation with RCWA and FDTD
+Author-email: FieldAlgo <dev@fieldalgo.com>
+License-Expression: Apache-2.0 AND MIT
+Project-URL: Homepage, https://github.com/fieldalgo/wavebit
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSE.fmmax
+License-File: LICENSE.meent
+Requires-Dist: numpy>=2.5.1
+Requires-Dist: scipy>=1.18
+Requires-Dist: array-api-compat>=1.15
+Provides-Extra: jax
+Requires-Dist: jax>=0.11; extra == "jax"
+Requires-Dist: jaxlib>=0.11; extra == "jax"
+Requires-Dist: optax>=0.2; extra == "jax"
+Requires-Dist: tqdm>=4.67; extra == "jax"
+Provides-Extra: pytorch
+Requires-Dist: torch>=2.13; extra == "pytorch"
+Requires-Dist: tqdm>=4.67; extra == "pytorch"
+Provides-Extra: docs
+Requires-Dist: sphinx>=9.1; extra == "docs"
+Requires-Dist: pydata-sphinx-theme>=0.21; extra == "docs"
+Requires-Dist: myst-parser>=5.1; extra == "docs"
+Requires-Dist: sphinx-design>=0.7; extra == "docs"
+Requires-Dist: sphinx-external-toc>=1.1; extra == "docs"
+Requires-Dist: sphinxcontrib-mermaid>=2.1; extra == "docs"
+Provides-Extra: contour
+Requires-Dist: contourpy>=1.3; extra == "contour"
+Provides-Extra: plot
+Requires-Dist: matplotlib>=3.10.1; extra == "plot"
+Dynamic: license-file
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="assets/branding/wavebit_logo_dark.svg">
+    <img src="assets/branding/wavebit_logo.svg" width="45%" alt="Wavebit">
+  </picture>
+</p>
+
+# Wavebit
+
+[![tests](https://github.com/fieldalgo/wavebit/actions/workflows/tests.yml/badge.svg)](https://github.com/fieldalgo/wavebit/actions/workflows/tests.yml)
+[![license](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+[![python](https://img.shields.io/badge/python-3.12%2B-blue.svg)](https://www.python.org/)
+
+**Differentiable electromagnetic simulation: RCWA and FDTD behind one API, on NumPy, JAX and PyTorch.**
+
+Wavebit computes how light scatters from periodic nanostructures (RCWA) and how fields evolve in
+time (FDTD). It differentiates through the RCWA calculation, so the model that predicts a device's
+response is the model that optimizes it.
+
+* **Two solvers, one lifecycle.** `rcwa` and `fdtd` share `check` → `prepare` → `run`, the same
+  materials, explicit length units, radian angles, and fields in V/m and A/m.
+* **One implementation of the physics** on three array backends. Cross-backend agreement is part of
+  the test suite, not a promise.
+* **Gradients where you need them.** Wavelength, materials, layer thicknesses and raster
+  permittivities differentiate on JAX and PyTorch; shape dimensions on PyTorch. The full table is in
+  the [differentiation guide](docs/guide/common/autodiff.md#rcwa-which-inputs-differentiate-on-which-backend).
+* **Checked against the outside world.** RETICOLO, fmmax and S4 for RCWA; Meep for FDTD; the Li (1997)
+  crossed-grating benchmark. The numbers and how they were taken: [validation](docs/validation/index.md).
+
+**Status: 0.0.2, alpha.** RCWA is the mature path. FDTD runs on CPU in double precision; its geometry,
+material and derivative support is reported by `check` for each problem. The API may change before
+1.0. An experimental RCWA solver for metal contacts is opt-in and has its own, narrower scope; read
+[method selection](docs/guide/rcwa/nvf-method-selection.md) before enabling it.
+
+## Install
+
+Python 3.12 or newer.
+
+```shell
+pip install wavebit              # NumPy backend
+pip install 'wavebit[jax]'       # or 'wavebit[pytorch]', or 'wavebit[jax,pytorch]' — differentiation backends
+```
+
+From a source checkout, for development:
+
+```shell
+git clone https://github.com/fieldalgo/wavebit.git && cd wavebit
+pip install -e '.[jax,docs]'     # editable, with the documentation toolchain
+```
+
+`environment.yml` builds the full development environment, including what the studies need. The
+version floors in [`pyproject.toml`](pyproject.toml) are the versions the suite is verified against;
+each is commented with the reason it sits where it does.
+
+## Quickstart
+
+A binary grating on glass under normal incidence, on the NumPy backend:
+
+```python
+import numpy as np
+from wavebit import Material, Units, rcwa
+
+problem = rcwa.Problem(
+    units=Units(length="nm"),
+    stack=rcwa.Stack(
+        period=(700., 700.),
+        bottom=Material(epsilon=2.25),
+        layers=(rcwa.Layer(thickness=300., epsilon=np.array([[1., 1., 12.25, 12.25]])),),
+    ),
+    excitation=rcwa.Excitation(wavelength=900., sources=(rcwa.PlaneWave(polarization="s"),)),
+)
+numerics = rcwa.Numerics(orders=(10, 0))
+result = rcwa.run(problem, numerics=numerics)
+print(float(result.R.sum()), float(result.T.sum()))
+print(result.transmission.order(0, 0).efficiency)
+```
+
+Diffraction arrays keep `(wavelength, order_v, order_u)` axes even for a single wavelength. `R` and
+`T` are efficiencies; absolute port power and its integration measure are recorded separately.
+
+To differentiate, prepare once and run with live leaves. JAX double precision is enabled by you,
+never by importing Wavebit:
+
+```python
+import jax, jax.numpy as jnp
+jax.config.update("jax_enable_x64", True)
+
+prepared = rcwa.prepare(problem, numerics=numerics, backend="jax")
+
+def transmitted(thickness):
+    layer = problem.stack.layers[0].replace(thickness=thickness)
+    live = problem.replace(stack=problem.stack.replace(layers=(layer,)))
+    return jnp.sum(prepared.run(live).T)
+
+gradient = jax.grad(transmitted)(jnp.asarray(300.))
+```
+
+The FDTD entry point works the same way; [`examples/fdtd/pulse_slab.py`](examples/fdtd/pulse_slab.py)
+is the first thing to run. The conventions both solvers follow — relative permittivity,
+`exp(-iωt)` phasors, bottom-to-top layers, centered cells, explicit units — are listed once in the
+[documentation home](docs/index.md#seven-conventions-to-check) and defined normatively in
+[`docs/reference/common/conventions.md`](docs/reference/common/conventions.md).
+
+## Documentation
+
+The prose is split by who is reading, the way NumPy's manual is:
+
+| | For a reader who |
+| --- | --- |
+| [`docs/guide/`](docs/guide) | needs the contract for one keyword: the manual |
+| [`docs/reference/`](docs/reference) | needs a signature or a guarantee |
+| [`docs/design/`](docs/design), [`docs/development/`](docs/development) | is questioning a default, and wants what was measured to decide it |
+| [`docs/validation/`](docs/validation) | wants the evidence behind a claim |
+| [`tutorials/`](tutorials) | has not used the API yet: start with the [RCWA](tutorials/rcwa/00-unified-lifecycle.ipynb) or [FDTD](tutorials/fdtd/00-unified-lifecycle.ipynb) notebook |
+| [`examples/`](examples) | wants it applied to a problem |
+| [`studies/`](studies) | wants the raw measurement behind a number in `docs/` |
+
+The same pages build as a site (`pip install -e '.[docs]'`, then
+`sphinx-build -b html docs docs/_build/html`); a hosted copy is coming. Every link in `docs/` is a
+relative link to a real file, and a test checks that every path a page cites exists.
+`python -m wavebit.manifest` prints every option, refusal and constraint as one JSON document for
+programs that need to know without reading the source
+([capability manifest](docs/reference/common/capability-manifest.md)).
+
+## Contributing
+
+Bug reports, questions and pull requests are welcome. [CONTRIBUTING.md](CONTRIBUTING.md) opens
+with the rule for where a new file belongs, and explains how changes are reviewed and landed.
+
+## Citation
+
+```bibtex
+@software{wavebit,
+    title  = {Wavebit: Differentiable Electromagnetic Simulation Suite},
+    author = {Kim, Yongha},
+    year   = {2026},
+    url    = {https://github.com/fieldalgo/wavebit},
+}
+```
+
+## License
+
+Apache-2.0. [LICENSE](LICENSE) also carries the third-party notices this project owes.
+
+## Contact
+
+[dev@fieldalgo.com](mailto:dev@fieldalgo.com)