tidy3d.web.load#

tidy3d.web.load(task_id: str, path: str = 'simulation_data.hdf5', replace_existing: bool = True, verbose: bool = True, progress_callback: Callable[[float], None] = None) → Union[tidy3d.components.data.sim_data.SimulationData, tidy3d.components.heat.data.sim_data.HeatSimulationData]#

Download and load simulation results into a data object.

Parameters

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

  • path (str) – Download path to .hdf5 data file (including filename).

  • replace_existing (bool = True) – Downloads the data even if path exists (overwriting the existing).

  • verbose (bool = True) – If True, will print progressbars and status, otherwise, will run silently.

  • progress_callback (Callable[[float], None] = None) – Optional callback function called when downloading file with bytes_in_chunk as argument.

Returns

Object containing simulation data.

Return type

Union[SimulationData, HeatSimulationData]