gaps.batch.BatchJob

class BatchJob(config)

Bases: object

Framework for building a batched job suite.

Based on reV-batch.

This framework allows users to modify key-value pairs in input configuration files based on a top-level batch config file. This framework will create run directories for all combinations of input parametrics and run the corresponding GAPs pipelines for each job.

Parameters:

config (str) – File path to config json or csv (str).

Methods

cancel()	Cancel all pipeline modules for all batch jobs.
delete()	Clear all of the batch sub job folders.
run([dry_run, monitor_background])	Run the batch job from a config file.

Attributes

job_table	Batch job summary table.
sub_dirs	Job sub directory paths.

property job_table

Batch job summary table.

Type:

pd.DataFrame

property sub_dirs

Job sub directory paths.

Type:

list

cancel()

Cancel all pipeline modules for all batch jobs.

delete()

Clear all of the batch sub job folders.

Only the batch sub folders listed in the job summary csv file in the batch config directory are deleted.

run(dry_run=False, monitor_background=False)

Run the batch job from a config file.

Parameters:

• dry_run (bool) – Flag to make job directories without running.

• monitor_background (bool) – Flag to monitor all batch pipelines continuously in the background. Note that the stdout/stderr will not be captured, but you can set a pipeline “log_file” to capture logs.