Metadata-Version: 2.2
Name: flex-rf
Version: 0.1.0.dev1
Summary: Extremely large radio-frequency and microwave electrodynamics simulations.
Author-Email: "Flexcompute Inc." <support@flexcompute.com>
Project-URL: homepage, https://www.flexcompute.com/
Requires-Python: <3.15,>=3.11
Requires-Dist: tidy3d<2.12,>=2.11.0
Description-Content-Type: text/markdown

# 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:

```bash
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](https://tidy3d.simulation.cloud/).
2. Install `pipx` and run:

```bash
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](https://docs.flexcompute.com/projects/tidy3d/en/latest/faq/docs/faq/how-do-i-find-the-tidy3d-folder/index.html).

## 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](https://tidy3d.simulation.cloud/)
- Open the RF API reference for the main `flex-rf` and Tidy3D microwave entry
  points: [Tidy3D microwave API reference](https://docs.flexcompute.com/projects/tidy3d/en/latest/api/microwave/index.html)

## Related Products

`flex-rf` is part of a broader product ecosystem:

- [PhotonForge](https://docs.flexcompute.com/projects/photonforge/en/latest/)
  for photonics design and simulation workflows.
- [RF GUI](https://tidy3d.simulation.cloud/) for browser-based simulation
  setup and job management.
- [Tidy3D microwave docs](https://docs.flexcompute.com/projects/tidy3d/en/latest/api/microwave/index.html)
  for deeper RF reference material.

## Learn More

- [About our solver](https://www.flexcompute.com/tidy3d/)
