Running the Pipeline

From the Command Line

Individual steps and pipelines (consisting of a series of steps) can be run from the command line using the strun command:

$ strun <pipeline_name, class_name, or input_file>

The first argument to strun must be one of either a pipeline name, python class of the step or pipeline to be run. The second argument to strun is the name of the input data file to be processed. For a list of all the options available for strun, please read the STPIPE Documentation.

For example, the Stage 1 pipeline is implemented by the class romancal.pipeline.ExposurePipeline. The command to run this pipeline is:

$ strun romancal.pipeline.ExposurePipeline r0008308002010007027_06311_0019_WFI01_uncal.asdf

Pipeline classes also have a pipeline name, or alias, that can be used instead of thefull class specification. For example, romancal.pipeline.ExposurePipeline has the alias roman_elp and can be run as

$ strun roman_elp r0008308002010007027_06311_0019_WFI01_uncal.asdf

Exit Status

strun produces the following exit status codes:

  • 0: Successful completion of the step/pipeline

  • 1: General error occurred

  • 64: No science data found

From the Python Prompt

You can execute a pipeline or a step from within python by using the call method of the class.

The call method creates a new instance of the class and runs the pipeline or step. Optional parameter settings can be specified by via keyword arguments or supplying a parameter file. Some examples are shown below. For more information, see Execute via call():

from romancal.pipeline import ExposurePipeline
result = ExposurePipeline.call('r0000101001001001001_01101_0001_WFI01_uncal.asdf')

from romancal.linearity import LinearityStep
result = LinearityStep.call('r0000101001001001001_01101_0001_WFI01_uncal.asdf')

For more details on the different ways to run a pipeline step, see the Configuring a Step page.