rfx Documentation
rfx is a JAX-based differentiable FDTD simulator for RF and microwave engineering.
How to read these docs
Section titled “How to read these docs”| Configuration | What is documented |
|---|---|
| Recommended default | uniform Cartesian Yee RF workflows: cavity, waveguide, patch-style resonance, probes, Harminv, selected S-parameter workflows, and benchmarked far-field workflows |
| Port-specific calculations | lumped/wire, microstrip-line, rectangular waveguide, and coaxial-line workflows each use their matching calculator and stated geometry, mesh, and frequency limits |
| Curated public API | user-facing builders, observables, and reporting helpers; lower-level symbols are supporting reference |
| Other repository code | may exist in the repository, but is not a documented public workflow unless a guide and support entry cover it |
Start with the recommended default configuration unless a public guide states the exact limits for another configuration.
Getting Started
Section titled “Getting Started”| Guide | Description |
|---|---|
| Installation | Python/JAX install, GPU notes, dev setup |
| Quick Start | First simulation with the current high-level API |
| Your First Patch Antenna | Build a patch model, run a short check, and see what is required before reporting RF results |
| Studio, CLI, and MCP Experiments | Local Studio, versioned CPU experiments, replay bundles, and MCP approvals |
Modeling & Setup
Section titled “Modeling & Setup”| Guide | Description |
|---|---|
| Simulation API | Simulation, Result, materials, sources, probes, ports, and NTFF helpers |
| Materials & Geometry | Material library, Debye/Lorentz models, CSG shapes, and PCB stackup basics |
| Sources & Ports | Soft sources, lumped/wire ports, microstrip-line ports, waveguide ports, and coaxial-line reflection for exactly one face="top" port within its stated limits |
| Probes & S-Parameters | DFT probes, S-matrix helpers, Harminv, de-embedding, and exports |
| Memory Reduction | How to reduce FDTD/AD memory without crossing validation boundaries |
| Waveguide Ports | Modal waveguide excitation and S-matrix extraction |
Analysis & Validation
Section titled “Analysis & Validation”| Guide | Description |
|---|---|
| Validation | Public validation overview and support status |
| Benchmarks | Current reference cases, pass criteria, and reproduce commands |
| Convergence Study | Mesh-refinement workflow |
| Far-Field & RCS | NTFF radiation patterns and scattering workflows |
| Visualization & Analysis | Plots, exports, post-processing, and result interpretation |
Design & Optimization
Section titled “Design & Optimization”| Guide | Description |
|---|---|
| Autodiff and Adjoint Background | Gradient concepts for microwave engineers, mapped from Meep adjoint terminology to rfx autodiff workflows |
| Inverse Design | Gradient-based optimization with proxy objectives and validation caveats |
| Gradient Behavior | Where gradients are strong, weak, or noisy |
| Parametric Sweeps | Sequential sweeps and jax.vmap batch evaluation |
| Patch Antenna Design | Practical rectangular patch workflow |
Secondary hubs
Section titled “Secondary hubs”- Examples — recommended public runnable paths
- Validation — support and validation overview
- API — curated public API contract
Quick Links
Section titled “Quick Links”- GitHub: bk-squared/rfx
- Public docs snapshot: remilab.ai/rfx
- Top-level API exports:
rfx.__init__ - Package metadata:
pyproject.toml