Submitting Simulations

Generic Web API

Core Workflow

tidy3d.web.run(simulation[, task_name, ...])	Submit one or many simulations and return results in the same container shape.
tidy3d.web.upload(simulation[, task_name, ...])	Upload simulation to server, but do not start running Simulation.
tidy3d.web.start(task_id[, solver_version, ...])	Start running the simulation associated with task.
tidy3d.web.monitor(task_id[, verbose, ...])	Print the real time task progress until completion.
tidy3d.web.download(task_id[, path, ...])	Download results of task to file.
tidy3d.web.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.download_json(task_id[, path, ...])	Download the .json file associated with the Simulation of a given task.
tidy3d.web.download_log(task_id[, path, ...])	Download the tidy3d log file associated with a task.
tidy3d.web.load_simulation(task_id[, path, ...])	Download the .json file of a task and load the associated simulation.

Task Information

tidy3d.web.get_info(task_id[, verbose])	Return information about a simulation task or a modeler batch.
tidy3d.web.get_tasks([num_tasks, order, folder])	Get a list with the metadata of the last num_tasks tasks.

Cost Estimation

tidy3d.web.estimate_cost(task_id[, verbose, ...])	Compute the maximum FlexCredit charge for a given task.
tidy3d.web.real_cost(task_id[, verbose])	Get the billed cost for given task after it has been run.

Task Management

tidy3d.web.delete(task_id[, versions])	Delete server-side data associated with task.
tidy3d.web.delete_old(days_old[, folder_name])	Remove folder contents older than days_old.
tidy3d.web.abort(task_id)	Abort server-side data associated with task.

Account and System

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

Job and Batch Containers

tidy3d.web.Job	Interface for managing the running of a Simulation on server.
tidy3d.web.Batch	Interface for submitting several Simulation objects to sever.
tidy3d.web.BatchData	Holds a collection of SimulationData returned by Batch.

Information Containers

tidy3d.web.core.task_info.TaskInfo

General information about a task.

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.