tidy3d.web.download

Contents

tidy3d.web.download#

class download[source]#

Bases:

Download results of task to file.

Parameters:

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

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

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