Adding READMEs
authormarian <marian@f7af4fe6-9843-0410-8265-dc069ae4e863>
Tue, 29 Mar 2011 22:37:19 +0000 (22:37 +0000)
committermarian <marian@f7af4fe6-9843-0410-8265-dc069ae4e863>
Tue, 29 Mar 2011 22:37:19 +0000 (22:37 +0000)
+
removing obsolete macro
(Marian)

TPC/scripts/OCDBscan/README.content [new file with mode: 0644]
TPC/scripts/OCDBscan/README.local [new file with mode: 0644]
TPC/scripts/OCDBscan/loadTPCcalib.C [deleted file]

diff --git a/TPC/scripts/OCDBscan/README.content b/TPC/scripts/OCDBscan/README.content
new file mode 100644 (file)
index 0000000..140cde7
--- /dev/null
@@ -0,0 +1,46 @@
+The content of the directory:
+
+Scripts for visualization - expert view:
+   *  gui     - invoke the Calibration viewer pad  view application  (AliTPCCalibViewerGUI.cxx)
+   *  guiTime - invoke the Calibration viewer time(trend) view application (AliTPCCalibViewerGUITime.cxx)
+
+README:
+   * README.content              - this file
+   * README.local                - readme for locl analysis
+   * jdl/HowTo-CalibSummary.txt  - readme for alien based analysis
+
+Scripts to create summary QA information on Alien -  jdl subdirectory (Marek):
+   * jdl files and scripts to make a sumary calibr info per run on alien
+   * see jdl/HowTo-CalibSummary.txt
+   * jdl/CalibSummary.jdl  
+   * jdl/runCalibSummary.sh  
+   * jdl/validation.sh
+   * jdl/ConfigOCDB.C  
+   * jdl/runCalibSummary.C  
+
+Scripts for creating summary information - local version (see README.local)
+   *  needed to test the new calibration before porting request and to check the residual calibration
+   *  guiEnv.sh           - setup the environment to run the scripts
+   *  makeCalibTreeRun.sh - create a summary calibration information per run
+   *  makeRunList.sh      - macro to create the run list of interest            
+   *  makeCalibTree.sh    - Obsolete script (to be confirmed)
+
+ROOT macros:
+   * CalibSummary.C  - main macro to create calibration summary information
+   * loadLibsREC.C   - load libraries in order to run application with plain root (obsolete?)
+   * ConfigOCDB.C    - setup the OCDB paths (to check the new calinration before porting good to use specific storages)
+                     - to be modified correspondingly
+   * guiAlias.C      - define  aliases of variables (obsolete)
+   * NimStyle.C      - default style to make a trend pictures
+   * makeChain.C     - make a combined tree form a chain
+      *  * input     - list of the calibTimeTrees[Run].root
+      *  * output    - sumary tree - calibTime.root            
+   * makeTPCTrendPlots.C  - macro to make a trend graphs
+      *  * input     - calibTime.root
+   * makeTPCRunPlots.C  - macro to make a run default plots
+      *  * input        - calPads_[Run].root and [run]/calibObjects.root 
+      *  * output       - set of the default run calibration plots 
+
+Obsolete: 
+   * makeDefaultPlots.C - splitted to makeTPCTrendPlots.C and makeTPCRunPlots.C   - to be removed soon
+
diff --git a/TPC/scripts/OCDBscan/README.local b/TPC/scripts/OCDBscan/README.local
new file mode 100644 (file)
index 0000000..e643e33
--- /dev/null
@@ -0,0 +1,82 @@
+ABOUT:
+Authors: Jens Wiechula 
+         Marian Ivanov (marian.ivanov@cern.ch)
+Scripts for viusalization and analysis of the TPC OCDB entries and visualization of trends.
+For visualization and analisys purposes root trees and queries on top of trees are used.
+
+Algorithm:
+1. Creation of the run lists.   (Expert operation) 
+2. Making a calibration trees.  (Expert operation)
+3. OCDB visualization analysis. (Non /software/ expert mode) 
+
+Requiroments:
+1. AliRoot installed.
+2. Alien   installed + valid alien certificate
+3. In some cases (only to speed up tree creation process) the batch farm can be used.  
+4. Alien configuration/jobs ( see jdl/HowTo-CalibSummary.txt)
+
+----------
+Quickstart
+-----------
+
+Do the following:
+1. Setup environment
+   1.a) gui dependend variables
+        export SCRIPTDIR=$ALICE_ROOT/TPC/scripts/OCDBscan
+            or your local scriptdir if you want to modify it
+        e.g:
+        export SCRIPTDIR=`pwd`/scripts
+        
+        export PATH=$SCRIPTDIR:$PATH
+       source $SCRIPTDIR/guiEnv.sh
+        
+   1.b) Modify your guiEnv.sh script in $SCRIPTDIR
+   1.c) Run: source guiEnv.sh debug    
+   1.d) Check the output of script. All checks has to be OK.
+     
+2. Run tree creation (Jens Wiechula scripts):
+   makeRunList.sh  -> creates the run.list file
+
+3. Run jobs example
+   //
+   bgroup=/bguiRUN
+   for arun in `cat run.list`; do
+       echo submitting jobs for run $arun
+        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/
+        $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/
+   done;
+   
+
+4. Start the GUI browser. This should work always (even on your laptop). 
+guiTime
+
+
+----------------
+Customised setup
+----------------
+
+- Defining the OCDB directories (ConfigOCDB.C):
+Before starting the tree creation or gui the macro 'ConfigOCDB.C' is exectued. This macro should contain
+all the setup needed to point to the proper OCDB directories. If alien is used, alien needs also to be
+setup in the macro. Open the macro for examples.
+
+- General output information (guiEnv):
+In the 'guiEnv' script environment variables defining default output directories etc. See comments in the
+file for explanations.
+
+
+Troubleshouting:
+
+1. Check your environment.
+   source guiEnv.sh debug
+   1.a) If not execuitng check your $PATH
+   1.b) Check the output of script. All checks should be indicated OK.
+2. Modify environment if neccessary
+3. Missing ConfigOCDB.C macro. This macro is not provided by default.
+   It is setup specific. You should contact experts to get it.   
+4. Wrong ConfigOCDB.C macro, tests:
+   4.a) ls $SCRIPTDIR/ConfigOCDB.C  - file should exist
+   4.b) run ConfigOCDB.C macro in aliroot session. Check the output.
+
+In case of further problems, please inform authors.
\ No newline at end of file
diff --git a/TPC/scripts/OCDBscan/loadTPCcalib.C b/TPC/scripts/OCDBscan/loadTPCcalib.C
deleted file mode 100644 (file)
index 329b7db..0000000
+++ /dev/null
@@ -1,9 +0,0 @@
-void loadTPCcalib(){
-  //
-  //
-  //
-  gROOT->Macro("~/NimStyle.C");
-  gSystem->Load("libANALYSIS");
-  gSystem->Load("libTPCcalib");
-  printf("LOAD TPC calibration libraries\n\n");
-}