"cupid" Command

CUPID_V2.0

CUPID General Info     "cupid" Command     All Pipelines     All Modules     



 
How to use the 'cupid' command:
  (This script runs IRS pipelines.)
 
Usage: cupid PROCESSING_DIRECTORY(s) [OPTION(s)]
 
   PROCESSING_DIRECTORY (at least one is required)
     Generally each processing directory will contain a raw/ subdirectory.
     Output files will be created in the bcd/ and pbcd/ subdirectories.
     Leopard downloads often contain 4 processing directories (ch0 ch1 ch2 ch3)
 
 
   PIPELINE SELECTION options
      (default is to run the following 7 pipelines:
        BCD  COADD  BKSUB  BKSUBX  COADDX  BCDX  CUTOUT )
      Other pipelines may be selected with:
           PIPE/p1   or    PIPE/p1.p2.p3  where the pN are be any of:
        BCD    - run the BCD image pipeline
        COADD  - run the COADD image pipeline
        BKSUB  - run the background subtraction image pipeline
        BKSUBX - run the BKSUB extraction pipeline
        COADDX - run the COADD extraction pipeline
        BCDX   - run the BCD extraction pipeline
        CUTOUT - run the CUTOUT blue and red pipeline
        BCDACQ - run the BCDACQ peakup acquisition pipeline
        DARK   - run the DARK image pipeline
        1      - run: BCD
        2      - run: BCD COADD
        3      - run: BCD COADD BKSUB
        4      - run: BCD COADD BKSUB BKSUBX
        5      - run: BCD COADD BKSUB BKSUBX COADDX
        6      - run: BCD COADD BKSUB BKSUBX COADDX BCDX
        7      - run: BCD COADD BKSUB BKSUBX COADDX BCDX CUTOUT
        8      - run: BCD COADD BKSUB BKSUBX COADDX BCDX CUTOUT BCDACQ
    e.g.  PIPE/3  or  PIPE/BCD  or  PIPE/BCD.COADD.BKSUBX
 
 
   PARAMETER options will override module parameters in the BCD pipeline
     (default is to run with the same parameters as operational pipeline)
 
       SET.[module]-[param]=[value]  (sets param to value for module)
             e.g.  SET.droopop-a=0
                  (sets the "a" parameter to 0 for the droopop module)
 
 
   FLOW options change the which STEPS are run in the BCD pipeline
     (default is to run with the same steps as the operational pipeline)
 
       START.[STEP] to start processing of at specified step
             e.g.  START.SATCOR  (starts processing at the SATCOR step)
 
       STOP.[STEP] to stop processing after specified step
             e.g.  STOP.FLATAP  (stops processing after running the FLATAP setp)
 
       SKIP.[STEP] to skip a step
             e.g.  SKIP.STRAYCROSS  (skips over the STRAYCROSS step)
 
       DO.[STEP2].AFTER.[STEP1] to run STEP2 right after STEP1
             e.g.  DO.CUBESUB.AFTER.DARKBASE
               (temporarily moves the CUBESUB step after the DARKBASE step)
 
   The "PARAMETER" and "FLOW" options above apply to the BCD pipeline.
   However, these same options may be used for other pipelines if
   prepended appropriately.  Use:
       X/     for all of the extraction pipelines (BKSUBX COADDX BCDX)
       COADD/ for the COADD pipeline
       DARK/  for the DARK pipeline
    Examples:
                 X/SET.extract-nanDrop=1
                 X/STOP.IRS_TUNE
                 X/SKIP.TBL2FITS
                 COADD/SET.coad2d-cf=0.25
                 DARK/SET.darkest-r=22.0
 
EXAMPLES:

  cupid /scr/r33776128/ch0
  ... runs the 7 standard pipelines in /scr/r33776128/ch0
      (on all raw.fits files in /scr/r33776128/ch0/raw/)

  cupid /scr/r33776128/ch0 PIPE/BCD
  ... runs the BCD pipeline in /scr/r33776128/ch0
      (on all raw.fits files in /scr/r33776128/ch0/raw/)

  cupid /scr/r33776128/ch0 PIPE/8
  ... runs all 8 pipelines in /scr/r33776128/ch0
        (BCD COADD BKSUB BKSUBX COADDX BCDX CUTOUT BCDACQ)
      (on all raw.fits files in /scr/r33776128/ch0/raw/)

  cupid /scr/r33776128/ch0 PIPE/BCD.DARK STOP.DARKBASE
  ... runs BCD pipeline up through DARKBASE to produce individual cubes,
       and then co-adds the cubes together to make a single dark file.
    (This is how a custom DARK file is commonly produced.)

  cupid /scr/r33776128/ch0 PIPE/BCD.COADD.BKSUB
  ... runs pipelines BCD, COADD, and BKSUB in /scr/r33776128/ch0
      (on all raw.fits files in /scr/r33776128/ch0/raw/)

  cupid /scr/r33776128/ch* PIPE/6
  ... runs the first 6 standard pipelines for all channels
          (in /scr/r33776128/ch0, /scr/r33776128/ch1,
          /scr/r33776128/ch2 and /scr/r33776128/ch3)

  cupid /scr/r33776128/ch1 PIPE/COADDX X/STOP.IRS_TUNE
  ... does extractions on the coadds but stops after the IRS_TUNE step
          (does not produce FITS table files)

  cupid /scr/r33776128/ch0 PIPE/BCD SKIP.STRAYCROSS SET.snest_irs-gain=6.0
  ... runs BCD pipeline in /scr/r33776128/ch0 but:
          for snest_irs module set "-gain" parameter to 6.0 and
          skip over the STRAYCROSS step

  cupid /scr/r33776128/ch3 PIPE/BCD DO.DROOPRES.AFTER.STRAYCROSS
  ... runs entire BCD pipeline but does DROPRES after STRAYCROSS

  cupid /scr/r33776128/ch2 PIPE/BCD START.STRAYCROSS
  ... runs BCD pipelien starting at STRAYCROSS
       i.e. runs just steps: STARYCROSS, FLATAP, FPGEN