Project

General

Profile

art

The art command is used to process data using framework modules under the control of a FHICL configuration file.

Options are:


  Usage: art <-c <config-file>> <other-options> [<source-file>]+

  Basic options:
    -h [ --help ]                         produce help message
    --version                             Print art version (3.00.00)
    -c [ --config ] arg                   Configuration file.
    --process-name arg                    art process name.
    --prune-config                        Remove unused modules from the 
                                          fully-processed configuration.
    --print-available arg                 List all available plugins with the 
                                          provided suffix.  Choose from:
                                              'module'
                                              'plugin'
                                              'service'
                                              'source'
                                              'tool'
                                              'mfPlugin'
                                              'mfStatsPlugin'
    --print-available-modules             List all available modules that can be 
                                          invoked in a FHiCL file.
    --print-available-services            List all available services that can be
                                          invoked in a FHiCL file.
    --print-description arg               Print description of specified module, 
                                          service, source, or other plugin 
                                          (multiple OK).  Argument can be a 
                                          regular expression used to match the 
                                          plugin specification.  To narrow the 
                                          search to plugins with a particular 
                                          suffix, preface the regular 
                                          expressionwith the suffix (e.g. 
                                          service:TFileService).
    --status-bar                          Provide status bar that reports the 
                                          progress of retrieving plugin 
                                          information for a 'print-available' 
                                          command.

  Source options:
    -s [ --source ] arg                   Source data file (multiple OK); 
                                          precludes -S.
    -S [ --source-list ] arg              file containing a list of source files 
                                          to read, one per line; precludes -s.
    -e [ --estart ] arg                   Event # of first event to process.
    -n [ --nevts ] arg                    Number of events to process.
    --nskip arg                           Number of events to skip.

  Output options:
    -T [ --TFileName ] arg                File name for TFileService.
    --tmpdir arg                          Temporary directory for in-progress 
                                          output files (defaults to directory of 
                                          specified output file names).
    --tmpDir arg                          Synonym for --tmpdir.
    -o [ --output ] arg                   Event output stream file (optionally 
                                          specify stream with stream-label:fileNa
                                          me in which case multiples are OK).
    --no-output                           Disable all output streams.

  Processing options:
    -j [ --parallelism ] arg (=1)         Number of threads AND schedules to use 
                                          for event processing (default = 1, 0 = 
                                          all cores).
    --nschedules arg (=1)                 Number of schedules to use for event 
                                          processing (default = 1)
    --nthreads arg (=1)                   Number of threads to use for event 
                                          processing (default = 1, 0 = all cores)
    --default-exceptions                  Some exceptions may be handled 
                                          differently by default (e.g. 
                                          ProductNotFound).
    --rethrow-default                     All exceptions default to rethrow.
    --rethrow-all                         All exceptions overridden to rethrow 
                                          (cf rethrow-default).
    --errorOnFailureToPut [=arg(=true)]   Global flag that controls the behavior 
                                          upon failure to 'put' a product 
                                          (declared by 'produces') onto the 
                                          Event.  If 'true', per-module flags can
                                          override the value of the global flag.
    --errorOnMissingConsumes [=arg(=true)]
                                          If 'true', then an exception will be 
                                          thrown if any module attempts to 
                                          retrieve a product via the 'getBy*' 
                                          interface without specifying the 
                                          appropriate 'consumes<T>(...)' 
                                          statement in the module constructor.
    --errorOnSIGINT [=arg(=true)]         If 'true', a signal received from the 
                                          user yields an art return code 
                                          corresponding to an error; otherwise 
                                          return 0.

  Debugging options:
    -M [ --mt-diagnostics ] arg           Log art-specific multi-threading 
                                          diagnostics to the provided 
                                          destination.
    --trace                               Activate tracing.
    --no-trace                            Deactivate tracing.
    --timing                              Activate monitoring of time spent per 
                                          event/module.
    --timing-db arg                       Output time-tracking data to SQLite3 
                                          database with name <db-file>.
    --no-timing                           Deactivate time tracking.
    --memcheck                            Activate monitoring of memory use 
                                          (deprecated--per-job memory information
                                          printed in job summary).
    --memcheck-db arg                     Output memory use data to SQLite3 
                                          database with name <db-file>.
    --no-memcheck                         Deactivate monitoring of memory use.
    -g [ --data-dependency-graph ] arg    Print DOT file that shows the 
                                          dependency graph of modules, based on 
                                          the specified paths and 'consumes' 
                                          statements invoked by users; call 
                                          constructors of all modules and exit 
                                          just before processing the event loop.
    --validate-config arg                 Output post-processed configuration to 
                                          <file>; call constructors of all 
                                          sources, modules and services, 
                                          performing extra configuration 
                                          verification.  Exit just before 
                                          processing the event loop.
    --debug-config arg                    Output post-processed configuration to 
                                          <file> and exit. Equivalent to env 
                                          ART_DEBUG_CONFIG=<file> art ...
    --config-out arg                      Output post-processed configuration to 
                                          <file> and continue with job.
    --annotate                            Include configuration parameter source 
                                          information.
    --prefix-annotate                     Include configuration parameter source 
                                          information on line preceding parameter
                                          declaration.

  SAM options:
    --sam-web-uri arg                     URI for SAM web service.
    --sam-process-id arg                  SAM process ID.
    --sam-application-family arg          SAM application family.
    --sam-app-family arg                  SAM application family.
    --sam-application-version arg         SAM application version.
    --sam-app-version arg                 SAM application version.
    --sam-group arg                       SAM group.
    --sam-file-type arg                   File type for SAM metadata.
    --sam-data-tier arg                   SAM data tier (<spec-label>:<tier-spec>
                                          ).
    --sam-run-type arg                    Global run-type for SAM metadata.
    --sam-stream-name arg                 SAM stream name (<module-label>:<stream
                                          -name>).
    --sam-inherit-metadata                Input file provides the file type and 
                                          run type.
    --sam-inherit-file-type               Input file provides the file type.
    --sam-inherit-run-type                Input file provides the run type.