tidy3d.web.api.webapi.upload

Contents

tidy3d.web.api.webapi.upload#

class upload[source]#

Bases:

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

Parameters:

  • simulation (Union[Simulation, HeatSimulation, EMESimulation]) – 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.

  • simulation_type (str = "tidy3d") – Type of simulation being uploaded.

  • parent_tasks (List[str]) – List of related task ids.

  • source_required (bool = True) – If True, simulations without sources will raise an error before being uploaded.

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

  • reduce_simulation (Literal["auto", True, False] = "auto") – Whether to reduce structures in the simulation to the simulation domain only. Note: currently only implemented for the mode solver.

Returns:

Unique identifier of task on server.

Return type:

str

Notes

Once you’ve created a job object using tidy3d.web.api.container.Job, you can upload it to our servers with:

web.upload(simulation, task_name="task_name", verbose=verbose)

It will not run until you explicitly tell it to do so with tidy3d.web.api.webapi.start().

Inherited Common Usage