Submitting Simulations

Generic Web API

Core Workflow

web.run(simulation[, task_name, ...])	Submit one or many simulations and return results in the same container shape.
web.upload(simulation[, task_name, ...])	Upload a simulation to the server without starting it.
web.start(task_id[, solver_version, ...])	Start running an uploaded task.
web.monitor(task_id[, verbose, worker_group])	Print real-time task progress until completion.
web.download(task_id[, path, verbose, ...])	Download task results to an HDF5 file.
web.load(task_id[, path, replace_existing, ...])	Download and load simulation results into a data object.
web.api.asynchronous.run_async(simulations)	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

web.download_json(task_id[, path, verbose])	Download the .json simulation file associated with a task.
web.download_log(task_id[, path, verbose, ...])	Download the log file associated with a task.
web.load_simulation(task_id[, path, verbose])	Download a task's simulation file and load the associated workflow object.

Task Information

web.get_info(task_id[, verbose])
web.get_run_info(task_id)
web.get_tasks([num_tasks, order, folder])	Get metadata of tasks in the requested folder.

Cost Estimation

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

Task Management

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

Account and System

web.account([verbose])	Get account information including FlexCredit balance and usage limits.
web.test()	Confirm whether Tidy3D authentication is configured.
web.refresh_licenses()	Clear cached local license entitlements from the active config directory.

Job and Batch Containers

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

Information Containers

web.core.task_info.TaskInfo

General information about a task.

Mode Solver Web API

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