{
  "title": "load",
  "public_path": "flex_rf.web.load",
  "lookup_path": "tidy3d.web.load",
  "slug": "flex_rf/web/load",
  "public_url": "/rf/latest/autogenerated/flex_rf/web/load/",
  "object_kind": "function",
  "introduction": "Download and Load simulation results into `SimulationData` object.",
  "notes": "After the simulation is complete, you can load the results into a `SimulationData` object by its\n    `task_id` using:\n\n```python\nsim_data = web.load(task_id, path=\"outt/sim.hdf5\", verbose=verbose)\n```\n\nThe `load` method is very convenient to load and postprocess results from simulations\ncreated using Tidy3D GUI.",
  "examples": "",
  "references": "",
  "signature": "load(task_id: TaskId | None, path: PathLike | None = None, replace_existing: bool = True, verbose: bool = True, progress_callback: Callable[[float], None] | None = None, lazy: bool = False)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/web/api/webapi.py",
    "url": "",
    "lineno": 1282,
    "endlineno": 1385
  },
  "bases": [],
  "parameter_rows": [
    {
      "name": "task_id",
      "annotation": "TaskId | None",
      "default": "",
      "description": "",
      "origin": "declared"
    },
    {
      "name": "path",
      "annotation": "PathLike | None",
      "default": "None",
      "description": "",
      "origin": "declared"
    },
    {
      "name": "replace_existing",
      "annotation": "bool",
      "default": "True",
      "description": "",
      "origin": "declared"
    },
    {
      "name": "verbose",
      "annotation": "bool",
      "default": "True",
      "description": "",
      "origin": "declared"
    },
    {
      "name": "progress_callback",
      "annotation": "Callable[[float], None] | None",
      "default": "None",
      "description": "",
      "origin": "declared"
    },
    {
      "name": "lazy",
      "annotation": "bool",
      "default": "False",
      "description": "",
      "origin": "declared"
    }
  ],
  "members": [],
  "group": "flex_rf.web"
}