1 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
2 * See cxx source for full Copyright notice */
7 /// \brief The main page for code documenation
10 /*! \mainpage MUON code documentation
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.
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
23 - \ref README_evaluation
31 - \ref README_geometry
35 On this page you will find the first how to run the
36 simulation, reconstructin and evaluation chain. More details
37 and various macros can be found on the other pages.
39 \section s1 How to check that your aliroot is working well
41 There is a script file AlirootRun_MUONtest.sh which
42 allows for simulating, reconstructing and making the
43 invariant analysis of the generated Upsilon (1S).
44 The used configuration file is Config.C in MUON
49 $ALICE_ROOT/MUON/AlirootRun_MUONtest.sh [option]
52 The complete list of the option is printed when you call
53 the script with whatever non valid option, .eg. h:
56 ./AlirootRun_MUONtest.sh h
57 ERROR : extra option not recognized
58 Usage: AlirootRun_MUONtest.sh options (-SRXsrxn:tg:p:d:c:)
59 -S (-s) perform (or not) simulation (default is do it, i.e -S)
60 -R (-r) perform (or not) reconstruction (default is do it, i.e. -R)
61 -X event (-x) perform (or not) checks and dumps (default is do it for event 5, i.e. -X 5)
62 -n nevents (int) number of events to simulate (default 100)
63 -t will use OUTDIR as a tmp directory to generate raw data
64 -g seed (uint) seed to be used in simulation (default 1234567)
65 -p recoptions (quotified string) reconstruction options to use (default "SAVEDIGITS")
66 -d full path to output directory (default /work/projects/alice/trunk/AliRoot/MUON/test_out.100)
67 -c full path to configuration file for simulation (default /work/projects/alice/trunk/AliRoot/MUON/Config.C)
70 The results of this test are saved in test_out.nevent directory.
71 Please note that the CDB (Condition DataBase) is now always *required*
72 to perform either simulation or reconstruction. For the moment, a version
73 of that CDB is stored in CVS, so you should have one already in MUON/Calib
77 \section s2 How to check that your aliroot is working VERY well
79 There is a script file AlirootRun_MUONlongtest.sh which
80 allows for simulating, reconstructing and making the
81 -+invariant analysis of the generated Upsilon (1S).
82 This script generates a large number of Upsilon (20k)
83 in order to access differential quantities.
84 The used configuration file is Config.C in MUON
87 One should really run this script to check if the MUON
88 code can process a large number of events WITHOUT errors,
89 in particular before making important commits !!
93 $ALICE_ROOT/MUON/AlirootRun_MUONtestlong.sh
95 The results of this test are saved in testlong_out/ directory
96 and will be kept in CVS
98 (NOTE: the macros performing the calculations/plots MUONefficiency.C
99 and MUONplotefficiency.C are also able to handle J/Psi if
100 Config.C is modified accordingly )