# rfx

> JAX-native electromagnetic simulation: manuals, reproducible examples and generated API reference.

Channel: release. Package version: 1.8.0. Source commit: 7d1e97331656dd74ad0f5471653ac0c5effdff70.

Read the support boundaries before proposing a configuration. Importability, a successful run,
and a historical visualization do not establish accuracy or a supported gradient.

## API and support

- [Typed API inventory](https://remilab.ai/rfx/versions/v1.8.0/api/inventory.json): signatures, defaults, annotations, docstrings and pinned sources.
- [Deep API reference](https://remilab.ai/rfx/versions/v1.8.0/api/generated/rfx.html)
- [Support boundaries](https://remilab.ai/rfx/versions/v1.8.0/markdown/api/support-boundaries.md)
- [docs/guides/support_matrix.json](https://remilab.ai/rfx/versions/v1.8.0/api/support/support_matrix.json)
- [docs/guides/sparameter_support_matrix.json](https://remilab.ai/rfx/versions/v1.8.0/api/support/sparameter_support_matrix.json)
- [Build manifest](https://remilab.ai/rfx/versions/v1.8.0/docs-manifest.json): source SHA and file hashes.
- [Combined manual](https://remilab.ai/rfx/versions/v1.8.0/llms-full.txt)

## Manual and examples

- [Automation](https://remilab.ai/rfx/versions/v1.8.0/markdown/api/automation.md): Derived setup helpers for mesh, domain, and frequency-range configuration.
- [Geometry and Materials](https://remilab.ai/rfx/versions/v1.8.0/markdown/api/geometry-materials.md): Documented shape constructors and material registration for rfx.
- [API Reference](https://remilab.ai/rfx/versions/v1.8.0/markdown/api.md): Documented rfx API pages and configuration limits.
- [Results and Observables](https://remilab.ai/rfx/versions/v1.8.0/markdown/api/results-observables.md): What the public rfx run result contains, and how to choose observables.
- [Simulation](https://remilab.ai/rfx/versions/v1.8.0/markdown/api/simulation.md): Constructor, run loop, and orchestration entry points for the curated rfx API.
- [Sources and Ports](https://remilab.ai/rfx/versions/v1.8.0/markdown/api/sources-ports.md): Current source, waveform, and port entry points for rfx.
- [Support Boundaries](https://remilab.ai/rfx/versions/v1.8.0/markdown/api/support-boundaries.md): Current public support boundaries for rfx.
- [Examples](https://remilab.ai/rfx/versions/v1.8.0/markdown/examples.md): The 13-step learning path shipped in examples/, what each script teaches, and the port and boundary family it exercises.
- [rfx Gallery](https://remilab.ai/rfx/versions/v1.8.0/markdown/gallery.md): Visual examples whose pages state the available RF evidence and explain any limits.
- [Dielectric slab (normal incidence)](https://remilab.ai/rfx/versions/v1.8.0/markdown/gallery/multilayer_fresnel.md): Normal-incidence reflection and transmission of a lossless dielectric slab in free space — rfx FDTD against the exact transfer-matrix (Fresnel) solution to about 1%.
- [Patch Antenna Diagnostics](https://remilab.ai/rfx/versions/v1.8.0/markdown/gallery/patch_antenna.md): Plots and AD/FD data from a patch model that cannot support RF resonance, return-loss, or convergence conclusions.
- [Hollow rectangular waveguide (WR-90, TE10)](https://remilab.ai/rfx/versions/v1.8.0/markdown/gallery/waveguide_wr90.md): A TE10 mode propagates down an empty WR-90 guide above cutoff — |S11|/|S21| match the exact matched-guide answer, with a jax.grad sensitivity of |S21| to the dielectric fill validated against finite differences.
- [ADI Solver (Experimental)](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/adi-solver.md): Unconditionally stable ADI-FDTD for stiff meshes: the timestep trade, the accuracy envelope, and what is and is not yet validated.
- [Simulation API](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/api-reference.md): Links to the documented rfx API pages.
- [Autodiff and Adjoint Background](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/autodiff-adjoint.md): 
- [Benchmarks](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/benchmarks.md): Reference cases, pass criteria, required dependencies, and reproduce commands for rfx cross-validation.
- [Changelog](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/changelog.md): Public release summary for rfx
- [Contributing to rfx](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/contributing.md): 
- [Far-Field & Radar Cross Section](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/farfield-rcs.md): 
- [Your First Patch Antenna](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/first-patch.md): Build a 2.4 GHz rectangular patch model that passes preflight, then apply the checks required before reporting resonance or Q.
- [Gradient Behavior in rfx](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/gradient-behavior.md): 
- [rfx Documentation](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide.md): Entry point for the rfx guide; the full topic index is on the documentation home.
- [Installation](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/installation.md): Python/JAX install, GPU notes, and development setup for rfx.
- [Inverse Design](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/inverse-design.md): Gradient-based design through the FDTD solver: the manual jax.grad loop, which objective family runs inside optimize(), and the design-region driver.
- [Materials and Geometry](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/materials-geometry.md): Library and custom materials, dispersive poles, CSG shapes, PEC handling, and thin conductors in rfx.
- [Reduce Memory Use](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/memory-reduction.md): Estimate and reduce FDTD and reverse-mode AD memory use in rfx.
- [Migration Guide](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/migration.md): 
- [Non-Uniform Mesh](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/nonuniform-mesh.md): Graded-z mesh setup and limits for thin layered RF structures.
- [Parametric Sweeps](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/parametric-sweeps.md): Sequential sweeps, batch result collection, and vmap-oriented design-space exploration in rfx.
- [Probes and S-Parameters](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/probes-sparams.md): Extract field data with point, vector, and DFT-plane probes; compute S-parameters per port family; and pull resonances via harmonic inversion.
- [Quick Start](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/quickstart.md): First simulation with the current stable rfx high-level API.
- [Sources and Ports](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/sources-ports.md): rfx source and port primitives: waveforms, point and polarized sources, lumped/wire/microstrip/waveguide ports, TFSF plane waves, and how each feeds S-parameter extraction.
- [Studio, CLI, and MCP Experiments](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/studio-experiments.md): Create, run, inspect, and replay versioned CPU experiments.
- [Tutorial: Convergence Study](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/tutorial-convergence.md): Step-by-step mesh convergence analysis for rfx FDTD simulations.
- [Tutorial: Patch Antenna Design](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/tutorial-patch-antenna.md): Setup and validation workflow for a rectangular microstrip patch antenna in rfx.
- [Cross-Validation and Accuracy](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/validation.md): Where the validation evidence for an rfx result lives.
- [Visualization & Result Analysis](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/visualization-and-analysis.md): 
- [Waveguide Ports](https://remilab.ai/rfx/versions/v1.8.0/markdown/guide/waveguide-ports.md): 
- [rfx](https://remilab.ai/rfx/versions/v1.8.0/markdown/index.md): Differentiable FDTD for RF/Microwave — powered by JAX
- [Cross-Solver Validation](https://remilab.ai/rfx/versions/v1.8.0/markdown/validation/cross-solver.md): Runnable rfx comparisons with analytic results and other solvers.
- [Validation](https://remilab.ai/rfx/versions/v1.8.0/markdown/validation.md): Validation evidence and current configuration limits for rfx.
- [Recommended Configuration](https://remilab.ai/rfx/versions/v1.8.0/markdown/validation/reference-lane.md): Where to start and which RF calculations need additional limits.