tidy3d.web.upload#

tidy3d.web.upload(simulation: tidy3d.components.simulation.Simulation, task_name: str, folder_name: str = 'default', callback_url: Optional[str] = None, verbose: bool = True, progress_callback: Optional[Callable[[float], None]] = None) → str#

Upload simulation to server, but do not start running Simulation.

Parameters

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

  • task_name (str) – Name of task.

  • folder_name (str) – 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'}.

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

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

Returns

Unique identifier of task on server.

Return type

str

Note

To start the simulation running, must call start() after uploaded.