WorkFlow

class WorkFlow(work_dir, cfg, obs, conf, proc_id)

Bases: object

ECLAIRs pipeline workflow base object

init the attributes checking the parameters

Constructor

get the different parameters used by the process. check the validity of the parameters. construct the right deconvolution module for the process.

Parameters:

• work_dir (string (absolute path)) – working directory where to save scientific products
• cfg (ConfigParser) – pipeline input configuration
• obs (EclairsObservation) – observation parameters
• conf (PipelineConfiguration) – pipeline config
• proc_id (string) – id number of the process

Methods Summary

check_input_dir(cfg, proc_id)	check the working directory parameter
check_work_dir(work_dir)	check the working directory parameter
is_ok()	answer to the question if the pipeline status is ‘OK’
run()

Methods Documentation

check_input_dir(cfg, proc_id)

check the working directory parameter

Parameters:

• cfg (ConfigParser) – pipeline input configuration
• proc_id (string) – id number of the process

Returns:

input directory

Return type:

string

check_work_dir(work_dir)

check the working directory parameter

Parameters:work_dir (any (should be string (absolute path))) – working directory where to save scientific products

is_ok()

answer to the question if the pipeline status is ‘OK’

Returns:True if status==’OK’, False if not Return type:bool

run()