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().

  • verbose (bool = True) – If True, will print log messages, otherwise, will run silently.

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

  • worker_group (str = None) – worker group

  • pay_type (Union[PayType, str] = PayType.AUTO) – Which method to pay the simulation

  • priority (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 (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, 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. Default None leaves the server behaviour unchanged.

Note

To monitor progress, can call monitor() after starting simulation.