tidy3d.web.run#

tidy3d.web.run(simulation: Union[tidy3d.components.simulation.Simulation, tidy3d.components.heat.simulation.HeatSimulation], task_name: str, folder_name: str = 'default', path: str = 'simulation_data.hdf5', callback_url: str = None, verbose: bool = True, progress_callback_upload: Callable[[float], None] = None, progress_callback_download: Callable[[float], None] = None, solver_version: str = None, worker_group: str = None) → Union[tidy3d.components.data.sim_data.SimulationData, tidy3d.components.heat.data.sim_data.HeatSimulationData]#

Submits a simulation to the server, starts running, monitors progress, downloads, and loads results as a corresponding data object.

Parameters

  • simulation (Union[Simulation, HeatSimulation]) – Simulation to upload to server.

  • task_name (str) – Name of task.

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

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

  • 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'}.

  • verbose (bool = True) – If True, will print progressbars and status, otherwise, will run silently.

  • progress_callback_upload (Callable[[float], None] = None) – Optional callback function called when uploading file with bytes_in_chunk as argument.

  • progress_callback_download (Callable[[float], None] = None) – Optional callback function called when downloading file with bytes_in_chunk as argument.

  • solver_version (str = None) – target solver version.

  • worker_group (str = None) – worker group

Returns

Object containing solver results for the supplied simulation.

Return type

Union[SimulationData, HeatSimulationData]