{
  "title": "upload",
  "public_path": "flex_rf.web.upload",
  "lookup_path": "tidy3d.web.upload",
  "slug": "flex_rf/web/upload",
  "public_url": "/rf/latest/autogenerated/flex_rf/web/upload/",
  "object_kind": "function",
  "introduction": "Upload simulation to server, but do not start running `Simulation`.",
  "notes": "Once you've created a `job` object using `Job`, you can upload it to our servers with:\n\n```python\nweb.upload(simulation, task_name=\"task_name\", verbose=verbose)\n```\n\nIt will not run until you explicitly tell it to do so with `start`.\nPassing `solver_version` directly is deprecated. Set defaults via\n`td.config.run` instead. Non-`None` values passed here override the config\nfor this call.",
  "examples": "",
  "references": "",
  "signature": "upload(simulation: WorkflowType, task_name: str | None = None, folder_name: str = 'default', callback_url: str | None = None, verbose: bool = True, progress_callback: Callable[[float], None] | None = None, simulation_type: str | None = None, parent_tasks: list[str] | None = None, source_required: bool = True, solver_version: str | None = None, reduce_simulation: Literal['auto', True, False] = 'auto', verbose_estimate_cost: bool | None = None)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/web/api/webapi.py",
    "url": "",
    "lineno": 574,
    "endlineno": 715
  },
  "bases": [],
  "parameter_rows": [
    {
      "name": "simulation",
      "annotation": "WorkflowType",
      "default": "",
      "description": "",
      "origin": "declared"
    },
    {
      "name": "task_name",
      "annotation": "str | None",
      "default": "None",
      "description": "",
      "origin": "declared"
    },
    {
      "name": "folder_name",
      "annotation": "str",
      "default": "'default'",
      "description": "",
      "origin": "declared"
    },
    {
      "name": "callback_url",
      "annotation": "str | None",
      "default": "None",
      "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": "simulation_type",
      "annotation": "str | None",
      "default": "None",
      "description": "",
      "origin": "declared"
    },
    {
      "name": "parent_tasks",
      "annotation": "list[str] | None",
      "default": "None",
      "description": "",
      "origin": "declared"
    },
    {
      "name": "source_required",
      "annotation": "bool",
      "default": "True",
      "description": "",
      "origin": "declared"
    },
    {
      "name": "solver_version",
      "annotation": "str | None",
      "default": "None",
      "description": "",
      "origin": "declared"
    },
    {
      "name": "reduce_simulation",
      "annotation": "Literal['auto', True, False]",
      "default": "'auto'",
      "description": "",
      "origin": "declared"
    },
    {
      "name": "verbose_estimate_cost",
      "annotation": "bool | None",
      "default": "None",
      "description": "",
      "origin": "declared"
    }
  ],
  "members": [],
  "group": "flex_rf.web"
}