tidy3d.web.api.container.BatchData

class BatchData

Bases: Tidy3dBaseModel

Holds a collection of SimulationData returned by Batch.

Parameters:

• task_paths (Attribute: task_paths) –

  Type	Mapping[str, str]
  Default
  Description	Mapping of task_name to path to corresponding data for each task in batch.

• task_ids (Attribute: task_ids) –

  Type	Mapping[str, str]
  Default
  Description	Mapping of task_name to task_id for each task in batch.

• verbose (Attribute: verbose) –

  Type	bool
  Default	= True
  Description	Whether to print info messages and progressbars.

Notes

When the batch is completed, the output is not a SimulationData but rather a BatchData. The data within this BatchData object can either be indexed directly batch_results[task_name] or can be looped through batch_results.items() to get the SimulationData for each task.

See also

Batch:

Interface for submitting several Simulation objects to sever.

SimulationData:

Stores data from a collection of Monitor objects in a Simulation.

Notebooks

• Running simulations through the cloud

• Performing parallel / batch processing of simulations

Attributes

Methods

items()	Iterate through the simulations for each task_name.
load([path_dir])	Load Batch from file, download results, and load them.
load_sim_data(task_name)	Load a simulation data object from file by task name.

task_paths

task_ids

verbose

load_sim_data(task_name)

Load a simulation data object from file by task name.

items()

Iterate through the simulations for each task_name.

__getitem__(task_name)

Get the simulation data object for a given task_name.

classmethod load(path_dir='.')

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 Union[SimulationData, HeatSimulationData] for each Union[Simulation, HeatSimulation] in Batch.

Return type:

BatchData

__hash__()

Hash method.