A makeCalibTreeRun.sh - make summary trees per run
[u/mrichter/AliRoot.git] / TPC / scripts / OCDBscan / README
1 cdABOUT:
2 Authors: Jens Wiechula 
3          Marian Ivanov (marian.ivanov@cern.ch)
4  
5 Scripts for viusalization and analysis of the TPC OCDB entries and visualization of trends.
6 For visualization and analisys purposes root trees and queries on top of trees are used.
7
8 Algorithm:
9 1. Creation of the run lists.   (Expert operation) 
10 2. Making a calibration trees.  (Expert operation)
11 3. OCDB visualization analysis. (Non /software/ expert mode) 
12
13 Requiroments:
14 1. AliRoot installed.
15 2. Alien   installed + valid alien certificate
16 3. In some cases (only to speed up tree creation process) the batch farm can be used.  
17 4. Alien configuration/jobs to be included soon (Work in progress)
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/OCDBscan
31             or your local scriptdir if you want to modify it
32         e.g:
33         export SCRIPTDIR=/lustre/alice/miranov/OCDBscan/scripts
34         
35         export PATH=$SCRIPTDIR:$PATH
36         source $SCRIPTDIR/guiEnv.sh
37         
38    1.b) Modify your guiEnv.sh script in $SCRIPTDIR
39    1.c) Run: source guiEnv.sh debug    
40    1.d) Check the output of script. All checks has to be OK.
41      
42 2. Run tree creation (Jens Wiechula scripts) Options:
43    2.a)  Run on a list of run numbers with name 'list.txt', one run number per line
44          makeCalibTree -l list.txt
45    2.b) Run on a range of run numbers:
46         makeCalibTree -r 75000-80000
47    2.c) Run automatic tree creation for all runs in the
48         data taking period which was set up (see below)
49         !!!WARNING!!! this will take quite some time
50         makeCalibTree -a
51
52 3. OBSOLETE PART - Run tree creation for extended statistic. This part can be run only if batchcommand specified.  (Marian Ivanov part of scripts)
53    WARNING  this is just example usage of expert mode:
54    bgroup=/bgui
55    ifirst=110000        
56    ilast=115000
57    step=200
58    runList=`pwd`/run.list
59    bgadd $bgroup
60    for ((  startRun=$ifirst; startRun<$ilast; startRun=startRun+$step )) ; do 
61       let endRun=$startRun+$step 
62       echo $startRun $endRun   
63        echo $BATCHCOMMAND -g $bgroup -oo $GUI_OUTDIR/logs/out$startRun.log -eo $GUI_OUTDIR/logs/err$startRun.log makeCalibTree.sh $runList $startRun $endRun;
64     $BATCHCOMMAND -g $bgroup -oo $GUI_OUTDIR/logs/out$startRun.log -eo $GUI_OUTDIR/logs/err$startRun.log  makeCalibTree.sh $runList $startRun $endRun;    
65    done;
66
67 4. New approach -  run the jobs for each run separatelly - more robust - but more jobs
68    //
69    bgroup=/bguiRUN
70    for arun in `cat run.list`; do
71         echo submitting jobs for run $arun
72         echo  $BATCHCOMMAND -g $bgroup -oo $GUI_OUTDIR/logs/out$arun.log -eo $GUI_OUTDIR/logs/err$arun.log  makeCalibTreeRun.sh $arun alien://///alice/cern.ch/user/m/miranov/OCDBscan/
73         $BATCHCOMMAND -g $bgroup -oo $GUI_OUTDIR/logs/out$arun.log -eo $GUI_OUTDIR/logs/err$arun.log  $SCRIPTDIR/makeCalibTreeRun.sh $arun alien://///alice/cern.ch/user/m/miranov/OCDBscan/
74    done;
75    
76
77
78    
79
80 4. Start the GUI browser. This should work always (even on your laptop). 
81 guiTime
82
83
84 ----------------
85 Customised setup
86 ----------------
87
88 - Defining the OCDB directories (ConfigOCDB.C):
89 Before starting the tree creation or gui the macro 'ConfigOCDB.C' is exectued. This macro should contain
90 all the setup needed to point to the proper OCDB directories. If alien is used, alien needs also to be
91 setup in the macro. Open the macro for examples.
92
93 - General output information (guiEnv):
94 In the 'guiEnv' script environment variables defining default output directories etc. See comments in the
95 file for explanations.
96
97
98 Troubleshouting:
99
100 1. Check your environment.
101    source guiEnv.sh debug
102    1.a) If not execuitng check your $PATH
103    1.b) Check the output of script. All checks should be indicated OK.
104 2. Modify environment if neccessary
105 3. Missing ConfigOCDB.C macro. This macro is not provided by default.
106    It is setup specific. You should contact experts to get it.   
107 4. Wrong ConfigOCDB.C macro, tests:
108    4.a) ls $SCRIPTDIR/ConfigOCDB.C  - file should exist
109    4.b) run ConfigOCDB.C macro in aliroot session. Check the output.
110
111 In case of further problems, please inform authors.