artdaq

Recent versions of art have the “ --print-description” option, which provides a brief summary about a module and its configuration parameters. It would be useful to have a similar capability added for artdaq processes.

Example: “ art --print-description RootOutput”

====================================================================================================

    module_type : RootOutput (or "art/Framework/IO/Root/RootOutput")

        provider: art
        type    : output module
        source  : / [ external source ] /art/Framework/IO/Root/RootOutput_module.cc
        library : /mnt/sde/products/art/v2_10_02/slf7.x86_64.e15.prof/lib/libart_Framework_IO_Root_RootOutput_module.so

    Allowed configuration
    ---------------------

        ## Any parameters prefaced with '#' are optional.

        <module_label>: {

           module_type: RootOutput

           ## The following parameter is a user-provided list
           ## of filter paths. The default list is empty.

           SelectEvents: [
           ]

           outputCommands: [
              "keep *"  # default
           ]

           fileName: <string>

           dataTier: ""  # default

           streamName: ""  # default

           catalog: ""  # default

         # dropAllEvents: <bool>

           dropAllSubRuns: false  # default

         # fastCloning: <bool>

           tmpDir: "<parent-path-of-filename>"  # default

           compressionLevel: 7  # default

           saveMemoryObjectThreshold: -1  # default

           treeMaxVirtualSize: -1  # default

           splitLevel: 99  # default

           basketSize: 16384  # default

           dropMetaDataForDroppedData: false  # default

           dropMetaData: "NONE"  # default

           writeParameterSets: true  # default

           fileProperties: {

              maxEvents: 4294967295  # default

              maxSubRuns: 4294967295  # default

              maxRuns: 4294967295  # default

              maxInputFiles: 4294967295  # default

              ## Maximum size of file (in KiB)

              maxSize: 2130706432  # default

              ## Maximum age of output file (in seconds)

              maxAge: 4294967295  # default

              ## The 'granularity' parameter specifies the level at which
              ## a file may be closed, and thereby the granularity of the file.
              ## The following values are possible:
              ## 
              ##     Value        Meaning
              ##    =======================================================
              ##    "Event"       Allow file switch at next Event
              ##    "SubRun"      Allow file switch at next SubRun
              ##    "Run"         Allow file switch at next Run
              ##    "InputFile"   Allow file switch at next InputFile
              ##    "Job"         File closes at the end of Job
              ## 
              ## For example, if a granularity of "SubRun" is specified, but the
              ## file has reached the maximum events written to disk (as specified
              ## by the 'maxEvents' parameter), switching to a new file will NOT
              ## happen until a new SubRun has been reached (or there are no more
              ## Events/SubRuns/Runs to process).

              granularity: "Event"  # default
           }
        }

====================================================================================================

Art has completed and will exit with status 1.