Submitting Simulations#

Through python API#

tidy3d.web.api.webapi.run(simulation, task_name)

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

tidy3d.web.api.webapi.upload(simulation, ...)

Upload simulation to server, but do not start running Simulation.

tidy3d.web.api.webapi.estimate_cost(task_id)

Compute the maximum FlexCredit charge for a given task.

tidy3d.web.api.webapi.real_cost(task_id[, ...])

Get the billed cost for given task after it has been run.

tidy3d.web.api.webapi.get_info(task_id[, ...])

Return information about a task.

tidy3d.web.api.webapi.start(task_id[, ...])

Start running the simulation associated with task.

tidy3d.web.api.webapi.monitor(task_id[, verbose])

Print the real time task progress until completion.

tidy3d.web.api.webapi.download(task_id[, ...])

Download results of task to file.

tidy3d.web.api.webapi.load(task_id[, path, ...])

Download and Load simulation results into SimulationData object.

tidy3d.web.api.webapi.delete(task_id)

Delete server-side data associated with task.

tidy3d.web.api.webapi.download_log(task_id)

Download the tidy3d log file associated with a task.

tidy3d.web.api.webapi.download_json(task_id)

Download the .json file associated with the Simulation of a given task.

tidy3d.web.api.webapi.load_simulation(task_id)

Download the .json file of a task and load the associated simulation.

tidy3d.web.api.asynchronous.run_async(...[, ...])

Submits a set of Union[Simulation, HeatSimulation, EMESimulation] objects to server, starts running, monitors progress, downloads, and loads results as a BatchData object.

Convenience for Single and Batch#

tidy3d.web.api.container.Job

Interface for managing the running of a Simulation on server.

tidy3d.web.api.container.Batch

Interface for submitting several Simulation objects to sever.

tidy3d.web.api.container.BatchData

Holds a collection of SimulationData returned by Batch.

Information Containers#

tidy3d.web.core.task_info.TaskInfo

General information about task.

tidy3d.web.core.task_info.TaskStatus

The statuses that the task can be in.