tidy3d.web.api.webapi.load

Contents

tidy3d.web.api.webapi.load#

class load[source]#

Bases:

Download and Load simulation results into SimulationData object.

Notes

After the simulation is complete, you can load the results into a SimulationData object by its task_id using:

sim_data = web.load(task_id, path="outt/sim.hdf5", verbose=verbose)

The tidy3d.web.api.webapi.load() method is very convenient to load and postprocess results from simulations created using Tidy3D GUI.

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, EMESimulationData]

Inherited Common Usage