tidy3d.web.api.webapi.download_hdf5

Contents

tidy3d.web.api.webapi.download_hdf5#

class download_hdf5[source]#

Bases:

Download the .hdf5 file associated with the Simulation of a given task.

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

  • path (str = "simulation.hdf5") – Download path to .hdf5 file of simulation (including filename).

  • 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.

Inherited Common Usage