tidy3d.web.api.webapi.start

Contents

tidy3d.web.api.webapi.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.

Note

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

Inherited Common Usage