tidy3d.web.load_simulation
tidy3d.web.load_simulation#
- tidy3d.web.load_simulation(task_id: str, path: str = 'simulation.json', verbose: bool = True, progress_callback: Optional[Callable[[float], None]] = None) tidy3d.components.simulation.Simulation #
Download the .json file of a task and load the associated
Simulation
.- Parameters
task_id (str) – Unique identifier of task on server. Returned by
upload()
.path (str = "simulation.json") – Download path to .json 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.
- Returns
Simulation loaded from downloaded json file.
- Return type