tidy3d.web.webapi.upload
tidy3d.web.webapi.upload#
- tidy3d.web.webapi.upload(simulation: tidy3d.components.simulation.Simulation, task_name: str, folder_name: str = 'default', callback_url: Optional[str] = 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'}.
- Returns
Unique identifier of task on server.
- Return type
TaskId
Note
To start the simulation running, must call
start()after uploaded.