WorkFlow

class WorkFlow(work_dir, input_dir, obs, conf, proc_id)[source]

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
  • input_dir (string (absolute path)) – local directory with evts in it
  • obs (EclairsObservation) – observation parameters
  • conf (PipelineConfiguration) – pipeline config
  • proc_id (string) – id number of the process

Methods Summary

check_input_dir(input_dir) check the input local 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(input_dir)[source]

check the input local directory parameter

check in addition if there is any fits file in the directory

Parameters:input_dir (any (should be string (absolute path))) – local directory with evts in it
check_work_dir(work_dir)[source]

check the working directory parameter

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

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

Returns:True if status==’OK’, False if not
Return type:bool
run()[source]