M submitMerging.sh - Using groups for jobs submitting
[u/mrichter/AliRoot.git] / TPC / scripts / 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
18 ----------
19 Quickstart
20 -----------
21
22 Without thinking, you can do the following to create a tree with calibration entries.
23 The default settings should work, however you might want to change them for 'better' 
24 performance. 
25
26 Do the following:
27 1. Setup environment
28    1.a) gui dependend variables
29         export SCRIPTDIR=$ALICE_ROOT/TPC/scripts
30         export PATH=$SCRIPTDIR:$PATH
31         source $ALICE_ROOT/TPC/scripts/guiEnv.sh
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    bgroup=/bgui
49    ifirst=79000 
50    ilast=102000
51    step=250
52    runList=`pwd`/run.list
53    bgadd $bgroup
54    for ((  startRun=$ifirst; startRun<$ilast; startRun=startRun+$step )) ; do 
55       let endRun=$startRun+$step 
56       echo $startRun $endRun   
57        echo $BATCHCOMMAND -g $bgroup -oo $GUI_OUTDIR/logs/out$startRun.log -eo $GUI_OUTDIR/logs/err$startRun.log makeCalibTree.sh $runList $startRun $endRun;
58     $BATCHCOMMAND -g $bgroup -oo $GUI_OUTDIR/logs/out$startRun.log -eo $GUI_OUTDIR/logs/err$startRun.log  makeCalibTree.sh $runList $startRun $endRun;    
59    done;
60
61 4. Start the GUI browser. This should work always (even on your laptop). 
62 guiTime
63
64
65
66 -------------------
67 General information
68 -------------------
69 The macros and shell scripts used are stored in $ALICE_ROOT/TPC/CalibMacros/guiTime
70 If you would like to modify some setting (see below), but do not have write access to this
71 directory, you can copy the complete directory somewhere else and setup the environment
72 variables accordingly:
73
74 export SCRIPTDIR=path_to_my_directory
75 export PATH=$SCRIPTDIR:$PATH
76
77 - setup scripts
78 All user relevant setup is done the shell script 'guiEnv' and the root macro 'ConfigOCDB.C'
79 All other files don't need to be modified by the user.
80
81 - scripts for the tree creation:
82 makeCalibTree:        Steering script to launch the tree creation
83 makeCalibTreeList:    script running the actual root process to create the tree
84
85 - scripts to start the gui:
86 gui 'filename':       Start the CalibViewerGUI using the tree in file 'filename'. Invokes the script
87                       startGUI.C
88 guiTime ['filename']: Start the CalibViewerGUItime. Optionally a filename containing the calibration
89                       calibration tree can be specified. Otherwise the trees from the directory setup
90                       in guiEnv will be used (see below). Invokes the script startGUItime.C
91
92 -oter scripts:
93 loadlibsREC.C:        Root macro to load only libraries needed to start the gui and tree creation.
94
95
96 ----------------
97 Customised setup
98 ----------------
99
100 - Defining the OCDB directories (ConfigOCDB.C):
101 Before starting the tree creation or gui the macro 'ConfigOCDB.C' is exectued. This macro should contain
102 all the setup needed to point to the proper OCDB directories. If alien is used, alien needs also to be
103 setup in the macro. Open the macro for examples.
104
105 - General output information (guiEnv):
106 In the 'guiEnv' script environment variables defining default output directories etc. See comments in the
107 file for explanations.
108
109
110 Troubleshouting:
111
112 1. Check your environment.
113    source guiEnv.sh debug
114    1.a) If not execuitng check your $PATH
115    1.b) Check the output of script. All checks should be indicated OK.
116 2. Modify environment if neccessary
117 3. Missing ConfigOCDB.C macro. This macro is not provided by default.
118    It is setup specific. You should contact experts to get it.   
119 4. Wrong ConfigOCDB.C macro, tests:
120    4.a) ls $SCRIPTDIR/ConfigOCDB.C  - file should exist
121    4.b) run ConfigOCDB.C macro in aliroot session. Check the output.
122
123 In case of further problems, please inform authors.