tidy3d.web.api.webapi.get_info

Contents

tidy3d.web.api.webapi.get_info#

class get_info[source]#

Bases:

Return information about a simulation task or a modeler batch.

This function fetches details for a given task ID, automatically distinguishing between a standard simulation task and a modeler batch.

Parameters:

  • task_id (TaskId) – The unique identifier for the task or batch.

  • verbose (bool, optional) – If True (default), display progress bars and status updates. If False, the function runs silently.

Returns:

A TaskInfo object for a standard simulation task, or a BatchDetail object for a modeler batch.

Return type:

TaskInfo | BatchDetail

Raises:

ValueError – If no task is found for the given task_id.

Inherited Common Usage