tidy3d.web.webapi.run#

tidy3d.web.webapi.run(simulation: tidy3d.components.simulation.Simulation, task_name: str, folder_name: str = 'default', path: str = 'simulation_data.hdf5', callback_url: Optional[str] = None) → tidy3d.components.data.sim_data.SimulationData#

Submits a Simulation to server, starts running, monitors progress, downloads, and loads results as a SimulationData object.

Parameters

  • simulation (Simulation) – Simulation to upload to server.

  • task_name (str) – Name of task.

  • path (str = "simulation_data.hdf5") – Path to download results file (.hdf5), including filename.

  • folder_name (str = "default") – Name of folder to store task on web UI.

  • callback_url (str = None) – Http PUT url to receive simulation finish event. The body content is a json file with fields {'id', 'status', 'name', 'workUnit', 'solverVersion'}.

Returns

Object containing solver results for the supplied Simulation.

Return type

SimulationData