Tidy3D

Drafted by Michelle, modified on 06/22/2023

Getting start

Before using Tidy3D, you must first sign up for a user account.

By signing up for a free account, you can obtain an API key here. You can also manage your simulation jobs and access the graphic user interface if needed. https://docs.flexcompute.com/projects/tidy3d/en/stable/quickstart.html

Installation of Tidy3D Python API for Linux and Mac OS

pip install --user tidy3d

tidy3d configure --apikey=XXX

'XXX' is your API key, which can be copied from your account page in the web interface. For Windows, please follow the method in Figure 1.

Figure 1. Tidy3D: where to find API key and how to install for different devices

Example: There are two ways to build a new simulation: one is clicking the 'New Simulation' shown in Figure 2, which is a little bit like Ansys GUI, and the other is generating Python code.

Figure 2: Tidy3D GUI

It is very like Ansys, we need to config FDTD, add structure, source and monitor, then click run. After finished, we can click task details to get some information.

Figure 3. result. (From example Edge Coupler)

We can also download the data into MATLAB or python to analyze.

Page updated

Report abuse