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