Simulation API
This page is the guide-side API entrypoint for the current public surface. Use it to decide which API surface you need, then jump into the dedicated /rfx/api/ pages.
How to use the API docs
Section titled “How to use the API docs”rfx documents the supported public API through curated pages that users should start from.
Start with the curated API
Section titled “Start with the curated API”Use these pages first:
| Need | Page |
|---|---|
| Overall API map | /rfx/api/ |
Simulation construction and run semantics | /rfx/api/simulation/ |
Result, observables, Harminv, S-parameters | /rfx/api/results-observables/ |
| Shapes, materials, and dispersive models | /rfx/api/geometry-materials/ |
| Sources, lumped ports, microstrip-line ports, waveguide ports, and coaxial line reflection | /rfx/api/sources-ports/ |
auto_configure() and higher-level setup helpers | /rfx/api/automation/ |
| Supported, bounded, and outside the documented public support scope boundaries | /rfx/api/support-boundaries/ |
Current API contract rules
Section titled “Current API contract rules”- The current validated reference lane is the uniform Cartesian Yee RF workflow.
- S-parameter APIs are port-family-specific: lumped/wire ports use
run(compute_s_params=True), MSL ports usecompute_msl_s_matrix(), waveguide ports usecompute_waveguide_s_matrix(), and coaxial line reflection usescompute_coaxial_line_reflection(...). - Importable lower-level symbols are not public API promises unless documented in the curated API and support matrix.
- Prefer the newest current recommended workflow pages when choosing a public example or reference path.
Boundary rule
Section titled “Boundary rule”The public API is intentionally narrow. Supported public workflows are the ones described in the curated API pages and support matrices.