flex-rf 0.1.0.dev1

Extremely large radio-frequency and microwave electrodynamics simulations.

flex-rf

flex-rf is a software package for extremely large radio-frequency and microwave electrodynamics simulations using the finite-difference time-domain (FDTD) method. You can work with flex-rf through the Python package or through a web-based graphical user interface.

Quickstart

Install the latest stable flex-rf package:

pip install --user flex-rf

For flex-rf.tidy3d compatibility, configure the tidy3d package with the API key from your account:

1. Get your API key from the RF GUI.
2. Install pipx and run:

pip install pipx
pipx run tidy3d configure --apikey=XXX

If you need to configure the API key manually, place config.toml in the directory described in the Tidy3D configuration guide.

Start Here

After installation, choose the workflow that fits how you want to work with flex-rf.

Choose Your Workflow

• Use the Python package when you want scriptable simulation setup, automation, and postprocessing.
• Use the RF GUI when you want a browser-based workflow for simulation setup and job management: RF GUI
• Open the RF API reference for the main flex-rf and Tidy3D microwave entry points: Tidy3D microwave API reference

Related Products

flex-rf is part of a broader product ecosystem:

• PhotonForge for photonics design and simulation workflows.
• RF GUI for browser-based simulation setup and job management.
• Tidy3D microwave docs for deeper RF reference material.

Learn More

• About our solver