Write the PGE Config file

You can read about the file here: PGE Config File

Start by creating a file named PGE_<name>.yaml. We usually store all PGE configs in a common directory. The location to the PGE config file is then mentioned in the SciFlo Workflow Definition file.

The base template you can start with is:

# The runconfig section is intended to be used for dynamically generating the runconfig file used
# when running the PGEs. Any values set with a "null" should be filled in by the input
# preprocessor. Otherwise, a precondition evaluation error will be thrown.
runconfig:
  

# This lists all the precondition evaluation steps that this PGE needs to run prior to running the PGE.
# These functions should be defined in the precondition_definition.yaml
preconditions:

# For any of the precondition evaluation steps listed in the preconditions area,
# specify function arguments here

# Looks at the context to get metadata
fuction_name:
  keys:
    - keys for function to use

# This value will get used as part of the job id during the job submission step.
set_pge_job_name:
  template: ${key}

# When doing simulated PGE runs, this will mock together a set of metadata for the met.json output
set_mock_metadata:
  # Hard-coded values in the structure you want
  

# When performing simulated PGE runs, this sets the base name to be used when generating the output
# products.
set_base_name:
  template: template_product_name (e.g NISAR_L0_PR_RRST_VC00_${DAPHNE_Min_Time_Tag}_${DAPHNE_Max_Time_Tag}_${CompositeReleaseID}_${ProductCounter})
  # This tells the function how to format the date time string in the file name (if applicable) e.g.:
  date_time_formats:
    Time_Key_Name: [datetime format]
    e.g.
    DAPHNE_Min_Time_Tag: "%Y%m%dT%H%M%S"
    DAPHNE_Max_Time_Tag: "%Y%m%dT%H%M%S"


# The PGE name
pge_name: [PGE Name]

# Set the primary input type here
primary_input: [dataset name]

# List the extensions that the PGE generates
output_types:
  - [file extension of expected output]

# List the groups from the runconfig that Chimera will need to localize (download)
localize_groups:
  - group