gaps.pipeline.Pipeline#

class Pipeline(pipeline, monitor=True)[source]#

Bases: object

gaps pipeline execution framework

Parameters:

  • pipeline (path-like) – Pipeline config file path.

  • monitor (bool, optional) – Flag to perform continuous monitoring of the pipeline. By default, True.

Raises:

gapsConfigError – If “pipeline” key not in config file.

Methods

cancel_all(pipeline)

Cancel all jobs corresponding to pipeline

run(pipeline[, monitor])

Run the pipeline

Attributes

COMMANDS

name

Name of the pipeline job (directory of status file)

status

A pipeline status object
property status#

A pipeline status object

Type:

Status

property name#

Name of the pipeline job (directory of status file)

Type:

str

classmethod cancel_all(pipeline)[source]#

Cancel all jobs corresponding to pipeline

Parameters:

pipeline (path-like) – Pipeline config file path.

classmethod run(pipeline, monitor=True)[source]#

Run the pipeline

Parameters:

  • pipeline (path-like) – Pipeline config file path.

  • monitor (bool) – Flag to perform continuous monitoring of the pipeline.