tidy3d.web.api.mode.run

Contents

tidy3d.web.api.mode.run#

class run[source]#

Bases:

Submits a ModeSolver to server, starts running, monitors progress, downloads, and loads results as a ModeSolverData object.

Parameters:

  • mode_solver (ModeSolver) – Mode solver to upload to server.

  • task_name (str = "Untitled") – Name of task.

  • mode_solver_name (str = "mode_solver") – The name of the mode solver to create the in task.

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

  • results_file (PathLike = "mode_solver.hdf5") – Path to download results file (.hdf5).

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

  • progress_callback_upload (Callable[[float], None] = None) – Optional callback function called when uploading file with bytes_in_chunk as argument.

  • progress_callback_download (Callable[[float], None] = None) – Optional callback function called when downloading file with bytes_in_chunk as argument.

  • reduce_simulation (Literal["auto", True, False] = "auto") – Restrict simulation to mode solver region. If “auto”, then simulation is automatically restricted if it contains custom mediums.

  • pay_type (Union[PayType, str] = PayType.AUTO) – Which method to pay the simulation.

Returns:

Mode solver data with the calculated results.

Return type:

ModeSolverData