wiki:DC3PipelinePolicyDesign
Last modified 10 years ago Last modified on 02/12/2009 04:27:16 PM

DC3 Pipeline Policy Design

updated: Feb 12, 2009

Policy file components

  1. executionMode:
    • type: string
    • allowed values: "oneloop"
    • description: The value here is either "oneloop" or not present. "oneloop" means execute the pipeline for one event (sequence) and then shut it down after the last stage executes. Not present means to restart from the first stage after the last one completes.
  2. localLogMode:
    • type: bool
    • allowed values: true, false
    • default: false
    • description: if true will output a .log file for the pipeline and each slice in the working directory
  3. shutdownTopic:
    • type: string
    • default: "triggerShutdownEvent"
    • description: Before restarting the pipeline after the last stage, the harness waits 100 milliseconds to see if an event has arrived on that topic. If so, it shuts down; if not, it continues with the first stage (unless executionMode: "oneloop" is set as described above).
  4. eventBrokerHost:
    • type: string
    • default: "lsst8.ncsa.uiuc.edu"
    • description: ?
  5. shareDataOn:
    • type: bool
    • allowed values: true, false
    • default: false
    • description: set true to enable InterSlice communication globally
  6. topology:
    • type: policy
    • description: ?
    • components:
      1. type:
        • type: string
        • allowed values: "ring", ?
        • description: ?
      2. param1:
        • type: string
        • allowed value: "clockwise", "counterclockwise"
        • description: direction of the ring
  7. appStage:
    • type: policy
    • description: A pipeline policy may contain more contain multiple appStage policies, one for each stage in the pipeline
    • components:
      1. stageName:
        • type: string
        • description: fully qualified stage class name. For example "lsst.pex.harness.IOStage.InputStage"
      2. eventTopic:
        • type: string
        • description: This stage will wait until it receives an event by this name before executing.
      3. stagePolicy:
        • type: string
        • description: the file name of the policy file that should be used to configure this Stage. State "None" if no policy file should be used.
      4. shareData:
        • type: bool
        • allowed values: true, false
        • default: ?
        • description: if true, items marked as shared on the clipboard will be comunicated prior to execution of the process method for this stage.

Sample Pipeline Policy

# sample pipeline policy .paf file
localLogMode: true
executionMode: "oneloop"
eventBrokerHost: "lsst8.ncsa.uiuc.edu"
shutdownTopic: "triggerShutdownA" 

shareDataOn: true

topology: {
    type: "ring"
    param1: "clockwise"
    # param1: "counterclockwise"
}

appStage: {
    stageName: "lsst.pexhexamples.apps.SyncSetupStage"
    eventTopic: "None"
    stagePolicy: "None"
    shareData: false
}

appStage: {
    stageName: "lsst.pexhexamples.apps.SyncTestStage"
    eventTopic: "None"
    stagePolicy: "None"
    shareData: true
}