Skip to content

Install and first simulation

Download RayRF Studio, sign in, and run the included 5.8 GHz patch antenna from the Welcome Panel, follow the video or written steps below.

Download and install

RayRF Studio runs on Windows and Linux. Sign in at rayrf.com/dashboard/downloads and download the build for your platform.

  • Windows. Run RayRF-Studio-<version>-Setup.exe to install the app and add RayRF Studio to the Start menu.
  • Linux. Download the .AppImage, make it executable (chmod +x).

The desktop app has an automatic update checker that runs on startup to let you know when a new version is available.

Sign in

On the first launch with no license saved, the sign-in dialog presents three options: sign in with browser (recommended, fastest), enter license key manually (get it from your dashboard), or continue as viewer-only. Viewer mode is always free, so you can view projects and results even after your trial or subscription expires.

Once signed in, the Welcome Panel is shown. You can open this menu at any time using File then Welcome Panel.

  • Blank Project create an empty project with no layers, no geometry, and default settings.
  • Patch Antenna Example open the 5.8 GHz patch antenna.
  • Recent projects lists your recently opened .rfsim files.

The Welcome Menu can be closed with the Escape key or x in the top right. If you don't have a project open, a blank one will open, and if you already have a non-blank project open there is no effect.

Activate a license

Activation assigns a machine to your account.

  • Sign in through RayRF opens your browser to approve the sign-in. This requires logging into your RayRF account in this browser, which is convenient if it's your primary machine, but if it's a secondary/server machine you may want to use the license key method instead.
  • Enter license key uses the key from your dashboard, copy it in and click Activate.

The CLI uses the same license as the UI. rayrf auth --license-key KEY performs key-based activation, rayrf auth --status displays the current license state, and rayrf auth --deactivate releases the seat. Browser sign-in cannot be used with the CLI. For related information see the CLI overview.

Patch antenna example

Select Patch Antenna Example from the Welcome Panel. The example is a 5.8 GHz inset-feed patch antenna on an FR-4 stackup with reasonable sim settings. Use the Edit tab to explore the stackup and the geometry.

Open the Simulate tab and click Run Simulation. RayRF will ask you to save the project before running.

When a simulation is running you can use Stop Early to conclude results early or discard the run. The Energy Ringdown plot indicates net energy remaining in the system. FDTD typically runs to an energy decay ratio target between -30dB (~minimum for valid results) to -60dB (precise). See FDTD tips. When the ringdown target is reached, RayRF shows Simulation Finished, and results are available on each respective tab. See Running simulations.

Open the S-Parameters tab to inspect return loss (S11 only in this example) with the resonant dip near 5.8 GHz. See S-parameters. Open the Radiation Pattern to inspect directionality in full 3D and 2D polar E/H slices. See Radiation pattern.

Telemetry and updates

RayRF sends anonymous usage telemetry about which features you use. We never send any information about your designs, sim settings, results, or any text you input to the program. For full transparency you can view the exact raw telemetry data by going to Settings then Anonymous Usage Telemetry then View raw events sent in this session to see a json-format breakdown of the information sent. For example, the information includes time spent on each tab (40% on simulate, 30% on settings, 30% inspecting results, for example), simulation size (bucketed) such as <1M cells, 1M-10M cells, 10M-100M cells, >100M cells. Hardware specifications, runtime, and IF the program crashed which module name it came from, nothing more. Note that raw "crash logs" can contain a lot of identifying information about a user, and depending on the nature of the crash can leak information about the project. For these reasons we never send crash logs, only the section of the program that crashed. For example "frontend_python", or "backend_cpu" or "backend_gpu". Anonymous usage telemetry is on by default everywhere except the EU and UK to comply with local regulations.

The update checker runs at startup and offers Update now if a newer version is available. It's important to understand what Update now does, it will: Download the installer for the new version, verify its checksum, launch the new installer (you must click through the typical install steps), and close RayRF for you (if a project is open with unsaved changes or a running sim you will need to cancel or confirm closing). RayRF cannot be updated while it's running, so save your projects and finish simulation runs before updating. If you prefer to not install the update, use Remind me later or Skip this version. Update <version> available is shown in the title bar if the update was deferred, and you can click there to begin the update when convenient. Settings then Check for updates lets you check for a new version manually without restarting RayRF.