TPC/scripts/README

   1
   2 ABOUT:
   3 Authors: Jens Wiechula
   4          Marian Ivanov (marian.ivanov@cern.ch)
   5
   6 Scripts for viusalization and analysis of the TPC OCDB entries and visualization of trends.
   7 For visualization and analisys purposes root trees and queries on top of trees are used.
   8
   9 Algorithm:
  10 1. Creation of the run lists.   (Expert operation)
  11 2. Making a calibration trees.  (Expert operation)
  12 3. OCDB visualization analysis. (Non /software/ expert mode)
  13
  14 Requiroments:
  15 1. AliRoot installed.
  16 2. Alien   installed + valid alien certificate
  17 3. In some cases (only to speed up tree creation process) the batch farm can be used.
  18
  19 ----------
  20 Quickstart
  21 -----------
  22
  23 Without thinking, you can do the following to create a tree with calibration entries.
  24 The default settings should work, however you might want to change them for 'better'
  25 performance.
  26
  27 Do the following:
  28 1. Setup environment
  29    1.a) gui dependend variables
  30         export SCRIPTDIR=$ALICE_ROOT/TPC/scripts
  31         export PATH=$SCRIPTDIR:$PATH
  32    1.b) Modify your guiEnv.sh script in $SCRIPTDIR
  33    1.c) Run: source guiEnv.sh debug
  34    1.d) Check the output of script. All checks has to be OK.
  35
  36 2. Run tree creation (Jens Wiechula scripts) Options:
  37    2.a)  Run on a list of run numbers with name 'list.txt', one run number per line
  38          makeCalibTree -l list.txt
  39    2.b) Run on a range of run numbers:
  40         makeCalibTree -r 75000-80000
  41    2.c) Run automatic tree creation for all runs in the
  42         data taking period which was set up (see below)
  43         !!!WARNING!!! this will take quite some time
  44         makeCalibTree -a
  45
  46 3. Run tree creation for extended statistic. This part can be run only if batchcommand specified.  (Marian Ivanov part of scripts)
  47    WARNING  this is just example usage of expert mode:
  48
  49    ifirst=70000;
  50    ilast=90000;
  51    step=500;
  52    runList=`pwd`/run.list
  53    for ((  startRun=$ifirst; startRun<$ilast; startRun=startRun+$step )) ; do
  54       let endRun=$startRun+$step
  55       echo $startRun $endRun
  56        echo $BATCHCOMMAND -oo $GUI_OUTDIR/logs/out$startRun.log -eo $GUI_OUTDIR/logs/err$startRun.out makeCalibTree.sh $runList $startRun $endRun;
  57     $BATCHCOMMAND -oo $GUI_OUTDIR/logs/out$startRun.log -eo $GUI_OUTDIR/logs/err$startRun.out makeCalibTree.sh $runList $startRun $endRun;
  58    done;
  59
  60 4. Start the GUI browser. This should work always (even on your laptop).
  61 guiTime
  62
  63
  64
  65 -------------------
  66 General information
  67 -------------------
  68 The macros and shell scripts used are stored in $ALICE_ROOT/TPC/CalibMacros/guiTime
  69 If you would like to modify some setting (see below), but do not have write access to this
  70 directory, you can copy the complete directory somewhere else and setup the environment
  71 variables accordingly:
  72
  73 export SCRIPTDIR=path_to_my_directory
  74 export PATH=$SCRIPTDIR:$PATH
  75
  76 - setup scripts
  77 All user relevant setup is done the shell script 'guiEnv' and the root macro 'ConfigOCDB.C'
  78 All other files don't need to be modified by the user.
  79
  80 - scripts for the tree creation:
  81 makeCalibTree:        Steering script to launch the tree creation
  82 makeCalibTreeList:    script running the actual root process to create the tree
  83
  84 - scripts to start the gui:
  85 gui 'filename':       Start the CalibViewerGUI using the tree in file 'filename'. Invokes the script
  86                       startGUI.C
  87 guiTime ['filename']: Start the CalibViewerGUItime. Optionally a filename containing the calibration
  88                       calibration tree can be specified. Otherwise the trees from the directory setup
  89                       in guiEnv will be used (see below). Invokes the script startGUItime.C
  90
  91 -oter scripts:
  92 loadlibsREC.C:        Root macro to load only libraries needed to start the gui and tree creation.
  93
  94
  95 ----------------
  96 Customised setup
  97 ----------------
  98
  99 - Defining the OCDB directories (ConfigOCDB.C):
 100 Before starting the tree creation or gui the macro 'ConfigOCDB.C' is exectued. This macro should contain
 101 all the setup needed to point to the proper OCDB directories. If alien is used, alien needs also to be
 102 setup in the macro. Open the macro for examples.
 103
 104 - General output information (guiEnv):
 105 In the 'guiEnv' script environment variables defining default output directories etc. See comments in the
 106 file for explanations.
 107
 108
 109 Troubleshouting:
 110
 111 1. Check your environment.
 112    source guiEnv.sh debug
 113    1.a) If not execuitng check your $PATH
 114    1.b) Check the output of script. All checks should be indicated OK.
 115 2. Modify environment if neccessary
 116 3. Missing ConfigOCDB.C macro. This macro is not provided by default.
 117    It is setup specific. You should contact experts to get it.
 118 4. Wrong ConfigOCDB.C macro, tests:
 119    4.a) ls $SCRIPTDIR/ConfigOCDB.C  - file should exist
 120    4.b) run ConfigOCDB.C macro in aliroot session. Check the output.
 121
 122 In case of further problems, please inform authors.