tidy3d.web.estimate_cost#

tidy3d.web.estimate_cost(task_id: str, verbose: bool = True) → float#

Compute the maximum FlexCredit charge for a given task.

Parameters

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

  • verbose (bool = True) – Whether to log the cost and helpful messages.

Returns

Estimated maximum cost for Simulation associated with given task_id.

Return type

float

Note

Cost is calculated assuming the simulation runs for the full run_time. If early shut-off is triggered, the cost is adjusted proportionately. A minimum simulation cost may also apply, which depends on the task details.

Parameters

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

Returns

Estimated cost of the task in FlexCredits.

Return type

float