Submitting Simulations

Generic Web API

Core Workflow

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.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.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.

Download Utilities

tidy3d.web.api.webapi.download_json(task_id)	Download the .json file associated with the Simulation of a given task.
tidy3d.web.api.webapi.download_hdf5(task_id)	Download the .hdf5 file associated with the Simulation of a given task.
tidy3d.web.api.webapi.download_log(task_id)	Download the tidy3d log file associated with a task.
tidy3d.web.api.webapi.load_simulation(task_id)	Download the .json file of a task and load the associated simulation.

Task Information

tidy3d.web.api.webapi.get_info(task_id[, ...])	Return information about a task.
tidy3d.web.api.webapi.get_run_info(task_id)	Gets the % done and field_decay for a running task.
tidy3d.web.api.webapi.get_tasks([num_tasks, ...])	Get a list with the metadata of the last num_tasks tasks.

Cost Estimation

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.

Task Management

tidy3d.web.api.webapi.delete(task_id[, versions])	Delete server-side data associated with task.
tidy3d.web.api.webapi.delete_old([days_old, ...])	Delete all tasks older than a given amount of days.
tidy3d.web.api.webapi.abort(task_id)	Abort server-side data associated with task.

Account and System

tidy3d.web.api.webapi.account([verbose])	Get account information including FlexCredit balance and usage limits.
tidy3d.web.api.webapi.test()	Confirm whether Tidy3D authentication is configured.

Job and Batch Containers

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 a task.
tidy3d.web.core.task_info.TaskStatus	The statuses that the task can be in.

Mode Solver Web API

tidy3d.web.api.mode.run(mode_solver[, ...])	Submits a ModeSolver to server, starts running, monitors progress, downloads, and loads results as a ModeSolverData object.
tidy3d.web.api.mode.run_batch(mode_solvers)	Submits a batch of ModeSolver to the server concurrently, manages progress, and retrieves results.
tidy3d.web.api.mode.ModeSolverTask	Interface for managing the running of a ModeSolver task on server.