MUON/Doxymain.h

   1 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   2  * See cxx source for full Copyright notice                               */
   3
   4 // $Id$
   5
   6 /// \file Doxymain.h
   7 /// \brief The main page for code documenation
   8
   9
  10 /*! \mainpage MUON code documentation
  11
  12 This is the documentation for the MUON simulation and reconstruction code.
  13 It is a mix of general concepts and code implementation details.
  14 It is constantly updated by all dimuon code developers.
  15
  16 The documentation is organized in the thematic pages, defined in the
  17 README*.txt files, which follow the code organization in the libraries.
  18 Currently there are the documentation pages on
  19 - \ref README_sim
  20 - \ref README_rec
  21 - \ref README_base
  22 - \ref README_mchview
  23 - \ref README_evaluation
  24 - \ref README_fast
  25 - \ref README_raw
  26 - \ref README_mapping
  27 - \ref README_calib
  28 - \ref README_geometry
  29 - \ref README_trigger
  30 - \ref README_shuttle
  31
  32 On this page you will find the first how to run the
  33 simulation, reconstructin and evaluation chain. More details
  34 and various macros can be found on the other pages.
  35
  36 \section s1 How to check that your aliroot is working well
  37
  38 There is a script file AlirootRun_MUONtest.sh which
  39 allows for simulating, reconstructing and making the
  40 invariant analysis of the generated Upsilon (1S).
  41 The used configuration file is Config.C in MUON
  42 directory.
  43
  44 You have to type :
  45 <pre>
  46 $ALICE_ROOT/MUON/AlirootRun_MUONtest.sh [option]
  47 </pre>
  48
  49 The complete list of the option is printed when you call
  50 the script with whatever non valid option, .eg. h:
  51
  52 <pre>
  53 ./AlirootRun_MUONtest.sh h
  54 ERROR : extra option not recognized
  55 Usage: AlirootRun_MUONtest.sh options (-SRXsrxn:p:d:c:)
  56        -S (-s) perform (or not) simulation (default is do it, i.e -S)
  57        -R (-r) perform (or not) reconstruction (default is do it, i.e. -R)
  58        -X event (-x) perform (or not) checks and dumps (default is do it for event 5, i.e. -X 5)
  59        -n nevents (int) number of events to simulate (default 100)
  60        -p recoptions (quotified string) reconstruction options to use (default "SAVEDIGITS")
  61        -d full path to output directory (default /work/projects/alice/dev/AliRoot/MUON/test_out.100)
  62        -c full path to configuration file for simulation (default /work/projects/alice/dev/AliRoot/MUON/Config.C)
  63 </pre>
  64
  65 The results of this test are saved in test_out.nevent directory.
  66 Please note that the CDB (Condition DataBase) is now always *required*
  67 to perform either simulation or reconstruction. For the moment, a version
  68 of that CDB is stored in CVS, so you should have one already in MUON/Calib
  69 subdirectories.
  70
  71
  72 \section s2 How to check that your aliroot is working VERY well
  73
  74 There is a script file AlirootRun_MUONlongtest.sh which
  75 allows for simulating, reconstructing and making the
  76 -+invariant analysis of the generated Upsilon (1S).
  77 This script generates a large number of Upsilon (20k)
  78 in order to access differential quantities.
  79 The used configuration file is Config.C in MUON
  80 directory.
  81
  82 One should really run this script to check if the MUON
  83 code can process a large number of events WITHOUT errors,
  84 in particular before making important commits !!
  85
  86 You have to type :
  87 <pre>
  88 $ALICE_ROOT/MUON/AlirootRun_MUONtestlong.sh
  89 </pre>
  90 The results of this test are saved in testlong_out/ directory
  91 and will be kept in CVS
  92
  93 (NOTE: the macros performing the calculations/plots MUONefficiency.C
  94 and MUONplotefficiency.C are also able to handle J/Psi if
  95 Config.C is modified accordingly )
  96
  97 */