diff --git a/docs/roman/pipeline_run.rst b/docs/roman/pipeline_run.rst index bea5e76e5..2697fdb74 100644 --- a/docs/roman/pipeline_run.rst +++ b/docs/roman/pipeline_run.rst @@ -21,7 +21,7 @@ For example, the exposure level pipeline is implemented by the class run this pipeline is: :: - $ strun romancal.pipeline.ExposurePipeline r0008308002010007027_0019_wfi01_uncal.asdf + $ strun romancal.pipeline.ExposurePipeline r0008308002010007027_06311_0019_WFI01_uncal.asdf Pipeline classes also have a **pipeline name**, or **alias**, that can be used @@ -30,7 +30,7 @@ instead of the full class specification. For example, can be run as :: - $ strun roman_elp r0008308002010007027_0019_wfi01_uncal.asdf + $ strun roman_elp r0008308002010007027_06311_0019_WFI01_uncal.asdf The mosaic level pipeline can be run in a similar manner and is implemented using the class :ref:`romancal.pipeline.MosaicPipeline `. @@ -70,8 +70,11 @@ Exit Status From the Python Prompt ------------------------------ -You can execute a pipeline or a step from within python. -Optional parameter settings can be specified by via keyword arguments or +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 the exposure pipeline and steps, @@ -79,12 +82,10 @@ For the exposure pipeline and steps, :: from romancal.pipeline import ExposurePipeline - elp = ExposurePipeline() - result = elp.call('r0000101001001001001_0001_wfi01_uncal.asdf') + result = ExposurePipeline.call('r0000101001001001001_01101_0001_WFI01_uncal.asdf') from romancal.linearity import LinearityStep - linearity = LinearityStep() - result = linearity.call('r0000101001001001001_0001_wfi01_uncal.asdf') + result = LinearityStep.call('r0000101001001001001_01101_0001_WFI01_uncal.asdf') One difference between the mosaic level pipeline and the exposure level pipeline is that the mosaic level pipeline is generally designed to run on multiple overlapping exposures. To achieve @@ -94,11 +95,13 @@ For the mosaic level pipeline and steps, :: from romancal.pipeline import MosaicPipeline - mosp = MosaicPipeline('r0000101001001001001_asn.json') + result = ExposurePipeline.call('r0000101001001001001_asn.json') from romancal.skymatch import SkyMatchStep - skymatch = SkyMatchStep.call('r0000101001001001001_asn.json') + result = SkyMatchStep.call('r0000101001001001001_asn.json') + +For more information, see :ref:`Execute via call()` For details on the different ways to run a pipeline step, see the :ref:`Configuring a Step` page.