MUON/Doxymain.h

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