tidy3d.web.run

tidy3d.web.run(simulation, task_name=None, folder_name='default', target_folder='out')

Runs a simulation and loads the results.

Parameters
  • simulation (Simulation) – Simulation object to run. After a successful run, the monitor data is downloaded and loaded in the simulation object.

  • task_name (str, optional) – Custom name for the task.

  • folder_name (str, optional) – Server folder to hold the task.

  • target_folder (str, optional) – Local folder to download the data.

Returns

TaskID string used for identifying this run after completion.

Return type

str