Public Examples

Use these examples to learn the supported workflows. They do not cover every importable module or experimental script in the repository.

Recommended entry points

Learning rfx — start here, in order:

Script	You learn
examples/quickstart/hello_world.py	install check, the minimal simulate-and-probe loop
examples/tutorials/ (ordered in examples/README.md)	boundaries, materials, run control, ports & S-parameters, resonance extraction, far-field patterns, RCS
examples/inverse_design/differentiable_s11_design.py	the differentiable design loop
examples/inverse_design/multilayer_ar_coating.py	conservative inverse-design demo

Validate a result

RF Workflows explains which example matches a design task. Cross-Solver Validation lists runnable checks against analytic calculations and other solvers.

Start with a uniform Yee-grid example when it fits the problem. Before using a result, inspect preflight warnings and confirm that the validation case covers the same mesh, source, port, material model, boundary, and output quantity.