Web.run?

Contents

Web.run?#

Date

Category

2025-09-16 13:50:36

Web API

The web.run function is a high-level API method for submitting a simulation to Flexcompute’s cloud server. It automatically uploads the simulation, runs it remotely, monitors progress, downloads the results, and loads them as a data object.

It is the general method to submit a simulation to the cloud, and it works with the Simulation, HeatChargeSimulation, web.Batch, and ModeSolver objects.

Example#

from tidy3d import web

# Submit and run the simulation
sim_data = web.run(
    simulation,
    task_name="my_task",
    path="out/sim.hdf5"
)

The web.run function requires the task_name string.

Optional arguments:

folder_name: Where to store the simulation in the web UI (default: “default”).

path: Local file path to save results (.hdf5).

verbose: If True, shows progress (default).

Contents