tidy3d.web.load

Contents

tidy3d.web.load#

class load[source]#

Bases:

Download and load simulation results into a data object.

Parameters:

  • task_id (Optional[str]) – Unique task ID returned by upload(). If None, path is assumed to point to an existing cached results file.

  • path (Optional[PathLike] = None) – Download path to the .hdf5 data file, including filename. When None and task_id is provided, a task-type-specific default filename is used.

  • replace_existing (bool = True) – Whether to download data even if path already exists, overwriting the file.

  • verbose (bool = True) – If True, print download and loading messages. If False, run silently.

  • progress_callback (Callable[[float], None] = None) – Optional callback used while downloading data.

  • lazy (bool = False) – Whether to load the actual data immediately (lazy=False) or return a proxy that loads data when accessed (lazy=True).

Returns:

Data object containing task results.

Return type:

WorkflowDataType

Notes

To load already-downloaded results without replacing the file, call this function with replace_existing=False.