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