tidy3d.web.run_async#

tidy3d.web.run_async(simulations: Dict[str, tidy3d.components.simulation.Simulation], folder_name: str = 'default', path_dir: str = '.', callback_url: Optional[str] = None, num_workers: Optional[int] = None, verbose: bool = True) → tidy3d.web.container.BatchData#

Submits a set of Simulation objects to server, starts running, monitors progress, downloads, and loads results as a BatchData object. Uses asyncio to perform these steps asynchronously.

Parameters

  • simulations (Dict[str, Simulation]) – Mapping of task name to simulation.

  • folder_name (str = "default") – Name of folder to store each task on web UI.

  • path_dir (str) – Base directory where data will be downloaded, by default current working directory.

  • callback_url (str = None) – Http PUT url to receive simulation finish event. The body content is a json file with fields {'id', 'status', 'name', 'workUnit', 'solverVersion'}.

  • num_workers (int = None) – Number of tasks to submit at once in a batch, if None, will run all at the same time.

  • verbose (bool = True) – If True, will print progressbars and status, otherwise, will run silently.

Note

This is an experimental feature and may not work on all systems or configurations. For more details, see https://realpython.com/async-io-python/.

Returns

Contains the SimulationData of each Simulation in Batch.

Return type

BatchData