Corrected/completed class description
[u/mrichter/AliRoot.git] / MUON / Doxymain.h
CommitLineData
b3cde273 1/*! \mainpage MUON code documentation
7537f3cf 2
3This is the documentation for the MUON simulation and reconstruction code.
91509ec6 4It is a mix of general concepts and code implementation details.
5It is constantly updated by all dimuon code developers.
6
7The documentation is organized in the thematic pages, defined in the
8README*.txt files, which follow the code organization in the libraries.
9Currently 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
b3cde273 15- \ref README_raw
16- \ref README_mapping
17- \ref README_calib
18- \ref README_geometry
19- \ref README_trigger
20- \ref README_shuttle
91509ec6 21
22On this page you will find the first how to run the
23simulation, reconstructin and evaluation chain. More details
24and various macros can be found on the other pages.
25
26\section s1 How to check that your aliroot is working well
27
28There is a script file AlirootRun_MUONtest.sh which
29allows for simulating, reconstructing and making the
30invariant analysis of the generated Upsilon (1S).
31The used configuration file is Config.C in MUON
32directory.
33
34You have to type :
35<pre>
36$ALICE_ROOT/MUON/AlirootRun_MUONtest.sh [option]
37</pre>
38
39The complete list of the option is printed when you call
40the script with whatever non valid option, .eg. h:
41
42<pre>
43./AlirootRun_MUONtest.sh h
44ERROR : extra option not recognized
45Usage: 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
55The results of this test are saved in test_out.nevent directory.
56Please note that the CDB (Condition DataBase) is now always *required*
57to perform either simulation or reconstruction. For the moment, a version
58of that CDB is stored in CVS, so you should have one already in MUON/Calib
59subdirectories.
60
61
62\section s2 How to check that your aliroot is working VERY well
63
64There is a script file AlirootRun_MUONlongtest.sh which
65allows for simulating, reconstructing and making the
66-+invariant analysis of the generated Upsilon (1S).
67This script generates a large number of Upsilon (20k)
68in order to access differential quantities.
69The used configuration file is Config.C in MUON
70directory.
71
72One should really run this script to check if the MUON
73code can process a large number of events WITHOUT errors,
74in particular before making important commits !!
75
76You have to type :
77<pre>
78$ALICE_ROOT/MUON/AlirootRun_MUONtestlong.sh
79</pre>
80The results of this test are saved in testlong_out/ directory
81and will be kept in CVS
82
83(NOTE: the macros performing the calculations/plots MUONefficiency.C
84and MUONplotefficiency.C are also able to handle J/Psi if
85Config.C is modified accordingly )
b3cde273 86
7537f3cf 87*/