tidy3d.plugins.adjoint.web.run#

tidy3d.plugins.adjoint.web.run = <jax._src.custom_derivatives.custom_vjp object>#

Submits a JaxSimulation to server, starts running, monitors progress, downloads, and loads results as a JaxSimulationData object. Can be included within a function that will have jax.grad applied.

Parameters

  • simulation (JaxSimulation) – Simulation to upload to server.

  • task_name (str) – Name of task.

  • path (str = "simulation_data.hdf5") – Path to download results file (.hdf5), including filename.

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

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

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

Returns

Object containing solver results for the supplied JaxSimulation.

Return type

JaxSimulationData