tidy3d.web.start

Contents

tidy3d.web.start#

class start[source]#

Bases:

Start running the simulation associated with task.

Parameters:

  • task_id (str) – Unique identifier of task on server. Returned by upload().

  • solver_version (Optional[str] = None) – Deprecated direct argument for internal use only. Internal workflows should set td.config.run.solver_version instead; external users should leave unset.

  • worker_group (Optional[str] = None) – Deprecated direct argument for worker group targeting, for internal use only. Internal workflows should set td.config.run.worker_group instead; external users should leave unset.

  • pay_type (Optional[Union[PayType, str]] = None) – Deprecated direct argument for internal use only. Internal workflows should set td.config.run.pay_type instead; external users should leave unset.

  • priority (Optional[int] = None) – Priority of the simulation in the Virtual GPU (vGPU) queue (1 = lowest, 10 = highest). It affects only simulations from vGPU licenses and does not impact simulations using FlexCredits.

  • vgpu_allocation (Optional[int] = None) – Number of virtual GPUs to allocate for the simulation (1, 2, 4, or 8). Only applies to vGPU license users. If not specified, uses td.config.vgpu.vgpu_allocation. If that is also unset, the system automatically determines the optimal GPU count.

  • ignore_memory_limit (Optional[bool] = None) – If True, allows the simulation to run even when estimated vGPU memory exceeds the allocation limit (up to 2x the limit). Only applies to vGPU license users. If None, uses td.config.vgpu.ignore_memory_limit.

Note

To monitor progress, can call monitor() after starting simulation. Passing these run options directly is deprecated. Set defaults via td.config.run and td.config.vgpu instead. Non-None values passed here override the config for this call.