o add Reset function to CalPad and CalROC o Add functionality to AliTPCdataQA - Reset...
[u/mrichter/AliRoot.git] / 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_eve
24 - \ref README_evaluation 
25 - \ref README_cosmics
26 - \ref README_fast
27 - \ref README_raw 
28 - \ref README_mapping 
29 - \ref README_mchda 
30 - \ref README_mtrda 
31 - \ref README_calib 
32 - \ref README_calign 
33 - \ref README_geometry 
34 - \ref README_trigger 
35 - \ref README_shuttle 
36
37 On this page you will find the first how to run the 
38 simulation, reconstructin and evaluation chain. More details
39 and various macros can be found on the other pages.
40
41 \section s1 How to check that your aliroot is working well
42
43 There is a script file AlirootRun_MUONtest.sh which 
44 allows for simulating, reconstructing and making the
45 invariant analysis of the generated Upsilon (1S).
46 The used configuration file is Config.C in MUON 
47 directory.
48
49 You have to type :
50 <pre>
51 $ALICE_ROOT/MUON/AlirootRun_MUONtest.sh [option]
52 </pre>
53
54 The complete list of the option is printed when you call
55 the script with whatever non valid option, .eg. h:
56
57 <pre>
58 ./AlirootRun_MUONtest.sh h
59 ERROR : extra option not recognized
60 Usage: AlirootRun_MUONtest.sh options (-SRXsrxn:tg:p:d:c:)
61        -S (-s) perform (or not) simulation (default is do it, i.e -S)
62        -R (-r) perform (or not) reconstruction (default is do it, i.e. -R)
63        -X event (-x) perform (or not) checks and dumps (default is do it for event 5, i.e. -X 5)
64        -n nevents (int) number of events to simulate (default 100)
65        -t will use OUTDIR as a tmp directory to generate raw data  
66        -g seed (uint) seed to be used in simulation (default 1234567)
67        -p recoptions (quotified string) reconstruction options to use (default "SAVEDIGITS")
68        -d full path to output directory (default /work/projects/alice/trunk/AliRoot/MUON/test_out.100)
69        -c full path to configuration file for simulation (default /work/projects/alice/trunk/AliRoot/MUON/Config.C)
70 </pre>
71
72 The results of this test are saved in test_out.nevent directory.
73 Please note that the CDB (Condition DataBase) is now always *required* 
74 to perform either simulation or reconstruction. For the moment, a version
75 of that CDB is stored in CVS, so you should have one already in MUON/Calib
76 subdirectories.
77
78
79 \section s2 How to check that your aliroot is working VERY well
80
81 There is a script file AlirootRun_MUONlongtest.sh which
82 allows for simulating, reconstructing and making the
83 -+invariant analysis of the generated Upsilon (1S).
84 This script generates a large number of Upsilon (20k) 
85 in order to access differential quantities. 
86 The used configuration file is Config.C in MUON
87 directory.
88
89 One should really run this script to check if the MUON 
90 code can process a large number of events WITHOUT errors,
91 in particular before making important commits !!
92
93 You have to type :
94 <pre>
95 $ALICE_ROOT/MUON/AlirootRun_MUONtestlong.sh
96 </pre>
97 The results of this test are saved in testlong_out/ directory
98 and will be kept in CVS
99
100 (NOTE: the macros performing the calculations/plots MUONefficiency.C 
101 and MUONplotefficiency.C are also able to handle J/Psi if 
102 Config.C is modified accordingly )
103
104 */