Simulation API

The documented rfx API consists of the /rfx/api/ pages listed below. Treat other importable symbols as implementation details unless a guide and support entry document their use.

API pages

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/
Recommended, limited, unsupported, or undocumented combinations	/rfx/api/support-boundaries/

API selection rules

• Start with the uniform Cartesian Yee RF workflow described in Recommended Configuration.

• S-parameter extraction is port-family-specific:

  • lumped/wire ports use run(compute_s_params=True);
  • waveguide ports use the Simulation.compute_waveguide_s_matrix() method;
  • microstrip-line (MSL) ports use Simulation.compute_msl_s_matrix();
  • coaxial line reflection uses Simulation.compute_coaxial_line_reflection(...).

  MSL and coaxial ports are not included in run(compute_s_params=True); call their dedicated method instead.

• An importable lower-level symbol is not part of the documented API unless it appears in these API pages and Support Boundaries.

• When choosing an example or validated configuration, prefer the documented API over lower-level imports.