queens.schedulers package

Schedulers.

Modules for scheduling and submitting computational jobs.

Submodules

queens.schedulers.cluster module

Cluster scheduler for QUEENS runs.

class Cluster(experiment_name, workload_manager, walltime, remote_connection, num_jobs=1, min_jobs=0, num_procs=1, num_nodes=1, queue=None, cluster_internal_address=None, restart_workers=False, allowed_failures=5, verbose=True)

Bases: Dask

Cluster scheduler for QUEENS.

copy_files_to_experiment_dir(paths)

Copy file to experiment directory.

Parameters:

paths (Path, list) – paths to files or directories that should be copied to experiment directory

restart_worker(worker)

Restart a worker.

This method retires a dask worker. The Client.adapt method of dask takes cares of submitting new workers subsequently.

Parameters:

worker (str, tuple) – Worker to restart. This can be a worker address, name, or a both.

timedelta_to_str(timedelta_obj)

Format a timedelta object to str.

This function seems unnecessarily complicated, but unfortunately the datetime library does not

support this formatting for timedeltas. Returns the format HH:MM:SS.

Parameters:

timedelta_obj (datetime.timedelta) – Timedelta object to format

Returns:

str – String of the timedelta object

queens.schedulers.local module

Local scheduler for QUEENS runs.

class Local(experiment_name, num_jobs=1, num_procs=1, restart_workers=False, verbose=True)

Bases: Dask

Local scheduler class for QUEENS.

restart_worker(worker)

Restart a worker.

Parameters:

worker (str, tuple) – Worker to restart. This can be a worker address, name, or a both.

queens.schedulers.pool module

Pool scheduler for QUEENS runs.

class Pool(experiment_name, num_jobs=1, verbose=True)

Bases: Scheduler

Pool scheduler class for QUEENS.

pool

Multiprocessing pool.

Type:

pathos pool

evaluate(samples, driver, job_ids=None)

Submit jobs to driver.

Parameters:

• samples (np.array) – Array of samples

• driver (Driver) – Driver object that runs simulation

• job_ids (lst, opt) – List of job IDs corresponding to samples

Returns:

result_dict (dict) – Dictionary containing results