ANALYSIS/examples/README

   1 # This directory contains reviewed analysis examples that can be used as templates
   2 # for a user analysis task. They are intended to demonstrate the usage of the
   3 # framework in all run modes and for different use cases. The code is not compiled
   4 # in a library but rather compiled runtime as any new analysis task is typically
   5 # developed.
   6 #
   7 # NOTE FOR USERS: When getting inspired from these tasks to develop your own code,
   8 # please take the time to personalize the content like: class names, includes, data
   9 # members, #define, ... and not just copy-paste the examples.
  10
  11 # NOTE FOR DEVELOPERS: When adding a new example please have in mind that this code
  12 # will be a source for may users to get inspired. Please make sure that:
  13 # - it runs in all modes (local, proof, grid)
  14 # - it is free of bugs and/or leaks
  15 # - code and specific actions are explained in detail
  16
  17  EXAMPLES
  18 ==========
  19 Ex01: Simple task demonstrating the usage of ESD track cuts to make inclusive
  20 pt and eta distributions for events selected via the offline physics selection.
  21  = Usage: root only
  22    .L runEx01.C
  23    run(<parameters>); // to select run mode, grid plugin mode, MC usage, dataset,...
  24  = Please check the sources which include useful comments.
  25  = To run in local mode, one should download locally data files and organize them in a
  26  = directory structure as used by files.txt. Alternatively one can change files.txt
  27  = to reflect its own local data.
  28
  29