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