Web.load?

Web.load?#

Date

Category

2025-09-16 13:50:36

Web API

The web.load function is a convenient utility in Tidy3D that allows you to download and load simulation results directly into a SimulationData, HeatChargeSimulationData, or ModeSolverData, depending on the simulation.

It is particularly useful for retrieving results from simulations created and run through the Tidy3D GUI or API.

Parameters#

  • task_id (str): Unique identifier for the simulation task (returned when uploading).

  • path (str): Local path where the results file (.hdf5) will be saved. Default: "simulation_data.hdf5".

  • replace_existing (bool): If True, overwrites existing files at the same path.

Notes#

The task_id can be obtained in the GUI under the Simulation Assets tab, or from the Action menu on the folder page.

For more information and templates on loading and visualizing data using web.load, see this example.

Example#

from tidy3d import web

sim_data = web.load(task_id, path="out/sim.hdf5", verbose=True)

# Now you can postprocess or visualize your simulation data
Contents