tidy3d.web.api.webapi.download_log

Contents

tidy3d.web.api.webapi.download_log#

class download_log[source]#

Bases:

Download the tidy3d log file associated with a task.

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

  • path (str = "tidy3d.log") – Download path to log file (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.

Note

To load downloaded results into data, call load() with option replace_existing=False.

Inherited Common Usage