tidy3d.web.upload

Contents

tidy3d.web.upload#

class upload[source]#

Bases:

Upload a simulation to the server without starting it.

Parameters:

  • simulation (WorkflowOperationType) – Simulation or single-step workflow operation to upload. Multi-step workflows should be submitted with run() or Job.

  • task_name (Optional[str] = None) – Name of the task. If omitted, a default task name is generated.

  • folder_name (str = "default") – Name of the web UI folder that will contain the task.

  • callback_url (Optional[str] = None) – HTTP PUT URL that receives the simulation finish event.

  • verbose (bool = True) – Whether to print progress, links, and status messages.

  • progress_callback (Callable[[float], None] = None) – Optional callback used while uploading data.

  • simulation_type (Optional[str] = None) – Simulation category override. If omitted, the configured default is used.

  • parent_tasks (list[str] = None) – Existing upstream task IDs associated with this upload.

  • source_required (bool = True) – Whether source-free simulations should be rejected before upload.

  • solver_version (Optional[str] = None) – Solver version override. If omitted, the configured default is used.

  • reduce_simulation (Literal["auto", True, False] = "auto") – Whether to reduce structures to the simulation domain when supported.

  • verbose_estimate_cost (Optional[bool] = None) – Whether to print cost estimation. If omitted, follows verbose.

Returns:

Unique task ID assigned by the server.

Return type:

str