tidy3d.web.Batch

class tidy3d.web.Batch(simulations, task_ids=None, task_names=None, base_dir='out/', folder_name='default', draft=False)

Container for processing set of simulations.

jobs

List of tidy3d.web.Job objects containing jobs to be processed.

Type

list

num_jobs

Number of jobs in the Batch.

Type

int

__init__(simulations, task_ids=None, task_names=None, base_dir='out/', folder_name='default', draft=False)

Construct.

Parameters
  • simulations (list) – List of Simulation to process in Batch.

  • task_ids (None, optional) – List of unique ID of task, can be found either on UI or through job.task_id.

  • task_names (list, optional) – List of strings corresponding to task name of each Simulation.

  • base_dir (str, optional) – Base of path corresponding to where data for this Batch will be stored.

  • folder_name (str, optional) – Server folder to hold the Batch.

  • draft (bool, optional) – If True, each job will be submitted but not run. It can then be visualized in the web UI and run from there when needed.

Methods

__init__(simulations[, task_ids, …])

Construct.

delete()

Delete all jobs in Batch.

download_json()

Downalod json file of each Job to it’s corresponding target_folder.

download_results()

Downalod data of each Job to it’s corresponding target_folder.

get_info()

Return list of dictionaries storing Batch metadata.

load_from_file(filename[, task_names, …])

Load a Batch from file containing newline separated list of task_ids.

load_from_task_ids(task_ids[, task_names, …])

Load a Batch from file containing newline separated list of task_ids.

load_results()

downloads results and either loads into list of simulations or returns list of new simulations

monitor()

Monitor progress of Batch in terms of number of jobs completed.

save(filename)

Save Batch info to file of newline-separated task_ids.