tidy3d.web.container.BatchData
tidy3d.web.container.BatchData#
- class tidy3d.web.container.BatchData#
Holds a collection of
SimulationData
returned byBatch
.- Parameters
task_paths (Mapping[str, str]) – Mapping of task_name to path to corresponding data for each task in batch.
task_ids (Mapping[str, str]) – Mapping of task_name to task_id for each task in batch.
Show JSON schema
{ "title": "BatchData", "description": "Holds a collection of :class:`.SimulationData` returned by :class:`.Batch`.\n\nParameters\n----------\ntask_paths : Mapping[str, str]\n Mapping of task_name to path to corresponding data for each task in batch.\ntask_ids : Mapping[str, str]\n Mapping of task_name to task_id for each task in batch.", "type": "object", "properties": { "task_paths": { "title": "Data Paths", "description": "Mapping of task_name to path to corresponding data for each task in batch.", "type": "object", "additionalProperties": { "type": "string" } }, "task_ids": { "title": "Task IDs", "description": "Mapping of task_name to task_id for each task in batch.", "type": "object", "additionalProperties": { "type": "string" } }, "type": { "title": "Type", "default": "BatchData", "enum": [ "BatchData" ], "type": "string" } }, "required": [ "task_paths", "task_ids" ], "additionalProperties": false }
- attribute task_ids: Dict[str, str] [Required]#
Mapping of task_name to task_id for each task in batch.
- attribute task_paths: Dict[str, str] [Required]#
Mapping of task_name to path to corresponding data for each task in batch.
- items() Tuple[str, tidy3d.components.data.sim_data.SimulationData] #
Iterate through the
SimulationData
for each task_name.
- classmethod load(path_dir: str = '.') tidy3d.web.container.BatchData #
Load
Batch
from file, download results, and load them.- Parameters
path_dir (str = './') – Base directory where data will be downloaded, by default current working directory. A batch.hdf5 file must be present in the directory.
- Returns
Contains the
SimulationData
of eachSimulation
inBatch
.- Return type
- load_sim_data(task_name: str) tidy3d.components.data.sim_data.SimulationData #
Load a
SimulationData
from file by task name.