# API Reference

Channel: release; package: 1.8.0; source: 7d1e97331656dd74ad0f5471653ac0c5effdff70

Page: https://remilab.ai/rfx/versions/v1.8.0/api/
Source: https://github.com/bk-squared/rfx/blob/7d1e97331656dd74ad0f5471653ac0c5effdff70/docs/public/api/index.mdx

The pages below define the documented rfx API. Treat importable symbols not
covered here as lower-level implementation details unless a guide and support
entry document their use.

## Pages

| Page | Focus | When to use it |
|---|---|---|
| [Simulation](https://remilab.ai/rfx/versions/v1.8.0/api/simulation/) | builder, run loop, auto-setup | you need to create and execute a job |
| [Geometry & Materials](https://remilab.ai/rfx/versions/v1.8.0/api/geometry-materials/) | shapes, material registration, dispersive poles | you need to place or define media |
| [Sources & Ports](https://remilab.ai/rfx/versions/v1.8.0/api/sources-ports/) | excitation, impedance loading, calibration | you need to drive a structure or measure S-parameters |
| [Results & Observables](https://remilab.ai/rfx/versions/v1.8.0/api/results-observables/) | return object fields and resonance extraction | you need to read solver outputs |
| [Automation](https://remilab.ai/rfx/versions/v1.8.0/api/automation/) | `auto_configure`, `Simulation.auto`, mesh helpers | you want a derived starting point |
| [Support Boundaries](https://remilab.ai/rfx/versions/v1.8.0/api/support-boundaries/) | recommended, limited, and unsupported combinations | you need to know whether a feature is documented |

## Current documented configuration

The documented API covers:

- uniform Cartesian Yee RF workflows
- PEC and CPML boundaries, plus UPML within its documented limits
- point/current sources
- lumped and wire ports
- specialized microstrip-line ports
- waveguide ports
- one-port coaxial line reflection with float32 precision, a nonperiodic 3D
  second-order uniform Yee grid, CPML on all six boundary faces with positive
  thickness on both z faces, `cpml_axes="z"`, and exactly one `face="top"`
  coaxial port; [Sources and Ports](https://remilab.ai/rfx/versions/v1.8.0/api/sources-ports/) lists the method's
  self-contained model and accepted arguments
- probes, Harminv resonance, benchmarked NTFF, and S-parameters only within the
  stated validation limits

For the exact configuration and restrictions, see
[Recommended Configuration](https://remilab.ai/rfx/versions/v1.8.0/validation/reference-lane/) and
[Support Boundaries](https://remilab.ai/rfx/versions/v1.8.0/api/support-boundaries/).