Adding READMEs
[u/mrichter/AliRoot.git] / TPC / scripts / OCDBscan / README.local
1 ABOUT:
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 ( see jdl/HowTo-CalibSummary.txt)
18
19 ----------
20 Quickstart
21 -----------
22
23 Do the following:
24 1. Setup environment
25    1.a) gui dependend variables
26         export SCRIPTDIR=$ALICE_ROOT/TPC/scripts/OCDBscan
27             or your local scriptdir if you want to modify it
28         e.g:
29         export SCRIPTDIR=`pwd`/scripts
30         
31         export PATH=$SCRIPTDIR:$PATH
32         source $SCRIPTDIR/guiEnv.sh
33         
34    1.b) Modify your guiEnv.sh script in $SCRIPTDIR
35    1.c) Run: source guiEnv.sh debug    
36    1.d) Check the output of script. All checks has to be OK.
37      
38 2. Run tree creation (Jens Wiechula scripts):
39    makeRunList.sh  -> creates the run.list file
40
41 3. Run jobs example
42    //
43    bgroup=/bguiRUN
44    for arun in `cat run.list`; do
45         echo submitting jobs for run $arun
46         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/
47         $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/
48    done;
49    
50
51 4. Start the GUI browser. This should work always (even on your laptop). 
52 guiTime
53
54
55 ----------------
56 Customised setup
57 ----------------
58
59 - Defining the OCDB directories (ConfigOCDB.C):
60 Before starting the tree creation or gui the macro 'ConfigOCDB.C' is exectued. This macro should contain
61 all the setup needed to point to the proper OCDB directories. If alien is used, alien needs also to be
62 setup in the macro. Open the macro for examples.
63
64 - General output information (guiEnv):
65 In the 'guiEnv' script environment variables defining default output directories etc. See comments in the
66 file for explanations.
67
68
69 Troubleshouting:
70
71 1. Check your environment.
72    source guiEnv.sh debug
73    1.a) If not execuitng check your $PATH
74    1.b) Check the output of script. All checks should be indicated OK.
75 2. Modify environment if neccessary
76 3. Missing ConfigOCDB.C macro. This macro is not provided by default.
77    It is setup specific. You should contact experts to get it.   
78 4. Wrong ConfigOCDB.C macro, tests:
79    4.a) ls $SCRIPTDIR/ConfigOCDB.C  - file should exist
80    4.b) run ConfigOCDB.C macro in aliroot session. Check the output.
81
82 In case of further problems, please inform authors.