]>
Commit | Line | Data |
---|---|---|
1dfba132 | 1 | // $Id$ |
2 | ||
631a1685 | 3 | /*! \page README_MUON_main MUON code documentation |
7537f3cf | 4 | |
5 | This is the documentation for the MUON simulation and reconstruction code. | |
91509ec6 | 6 | It is a mix of general concepts and code implementation details. |
7 | It is constantly updated by all dimuon code developers. | |
8 | ||
9 | The documentation is organized in the thematic pages, defined in the | |
10 | README*.txt files, which follow the code organization in the libraries. | |
11 | Currently there are the documentation pages on | |
94af1796 | 12 | - \subpage README_sim |
13 | - \subpage README_rec | |
14 | - \subpage README_base | |
15 | - \subpage README_mchview | |
16 | - \subpage README_eve | |
17 | - \subpage README_evaluation | |
18 | - \subpage README_cosmics | |
19 | - \subpage README_fast | |
20 | - \subpage README_raw | |
21 | - \subpage README_mapping | |
22 | - \subpage README_mchda | |
23 | - \subpage README_mtrda | |
24 | - \subpage README_calib | |
25 | - \subpage README_calign | |
26 | - \subpage README_geometry | |
27 | - \subpage README_trigger | |
28 | - \subpage README_shuttle | |
91509ec6 | 29 | |
30 | On this page you will find the first how to run the | |
31 | simulation, reconstructin and evaluation chain. More details | |
32 | and various macros can be found on the other pages. | |
33 | ||
34 | \section s1 How to check that your aliroot is working well | |
35 | ||
36 | There is a script file AlirootRun_MUONtest.sh which | |
37 | allows for simulating, reconstructing and making the | |
38 | invariant analysis of the generated Upsilon (1S). | |
39 | The used configuration file is Config.C in MUON | |
40 | directory. | |
41 | ||
42 | You have to type : | |
43 | <pre> | |
44 | $ALICE_ROOT/MUON/AlirootRun_MUONtest.sh [option] | |
45 | </pre> | |
46 | ||
47 | The complete list of the option is printed when you call | |
48 | the script with whatever non valid option, .eg. h: | |
49 | ||
50 | <pre> | |
51 | ./AlirootRun_MUONtest.sh h | |
52 | ERROR : extra option not recognized | |
19b50c28 | 53 | Usage: 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 | ||
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 ) | |
b3cde273 | 96 | |
7537f3cf | 97 | */ |