-/*! \mainpage MUON code documentation
-
-This is the documentation for the MUON simulation and reconstruction code.
-It is a mix of general concepts and code implementation details...
-
-\section ssimulation Simulation
-
-The simulation encompasses the following tasks :
-
-- generation of MC particles (the kinematics of the event ends up in the TreeK
- of Kinematics#.root)
-
-- tracking particles through the detector using
-the Virtual Monte Carlo, producing AliMUONHit objects, that end up in
- the TreeH of MUON.Hits#.root file(s). This part is steered by AliMUON and its child
-AliMUONv1 classes.
-
-- converting MC hits into AliMUONVDigit, called SDigits, that end up in the TreeS
- of the MUON.SDigits#.root file(s). A S(ummable)Digit is a pad with its associated
-charge, but no noise or electronics response function applied. Steered by AliMUONSDigitizerV2 class.
-
-- converting SDigits into Digits, by applying electronics calibrations. Actually, we de-calibrate
- the digits at this stage, by adding a pedestal and dividing by a gain, more or less. Steered
- by AliMUONDigitizerV3 class. Digits end up in TreeD of MUON.Digits#.root file(s). In addition,
- for the trigger, we create AliMUONLocalTrigger, AliMUONRegionalTrigger and AliMUONGlobalTrigger objects
-at this stage, that ends up in TreeD as well.
-
-- convert the Digits into RAW data, in a format that should be exactly the same as real data from the
-DAQ. Performed by AliMUONRawWriter.
-
-From there on, the reconstruction can proceed, in the very same way for real or simulated data,
- as long as they are in RAW format.
+/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ * See cxx source for full Copyright notice */
-\section sreconstruction Reconstruction
+// $Id$
-The reconstruction is a multistage process, driven by the AliMUONReconstructor class :
+/// \file Doxymain.h
+/// \brief The main page for code documenation
-- we read the RAW data, convert them (convert them back for simulated data) to
-AliMUONDigit. Performed by AliMUONDigitMaker.
-- we calibrate the digits, by subtracting pedestals and multiplying by gains. Performed
- by AliMUONDigitCalibrator. Calibrated digits might be saved (back) to TreeD.
-- we make clusters by associating digits, producing AliMUONRawCluster objects that end up
- in TreeR of MUON.RecPoints#.root file(s). Steered by AliMUONClusterReconstructor. @ref AliMUONVClusterFinder "More..."
-Part of the reconstruction, but not really steered by AliMUONReconstructor, is the
- last stage, the tracking, i.e. associating clusters to form tracks. Steered by AliMUONTracker.
- Producing AliMUONTrack objects that end up in TreeT of MUON.Tracks#.root and AliESDMuonTrack objects
-that end up in the ESD (Event Summary Data), AliESDs.root file. @ref AliMUONVTrackReconstructor "More..."
-
-\section sdataaccess Data access
-
-All the simulation and reconstruction use containers (called stores in MUON jargon) to hold
- the data we're dealing with : hits, (s)digits, trigger, clusters, tracks and trigger tracks.
- All those stores share some commonalities, in particular with respect to how they are read/written from/to
- TTree. @ref AliMUONVStore "More..."
+/*! \mainpage MUON code documentation
-See more in:
-- \ref README_main
+This is the documentation for the MUON simulation and reconstruction code.
+It is a mix of general concepts and code implementation details.
+It is constantly updated by all dimuon code developers.
+
+The documentation is organized in the thematic pages, defined in the
+README*.txt files, which follow the code organization in the libraries.
+Currently there are the documentation pages on
+- \ref README_sim
+- \ref README_rec
+- \ref README_base
+- \ref README_mchview
+- \ref README_eve
+- \ref README_evaluation
+- \ref README_cosmics
+- \ref README_fast
- \ref README_raw
- \ref README_mapping
+- \ref README_mchda
+- \ref README_mtrda
- \ref README_calib
+- \ref README_calign
- \ref README_geometry
- \ref README_trigger
- \ref README_shuttle
-- \ref README_evaluation
-- \ref README_fast
+
+On this page you will find the first how to run the
+simulation, reconstructin and evaluation chain. More details
+and various macros can be found on the other pages.
+
+\section s1 How to check that your aliroot is working well
+
+There is a script file AlirootRun_MUONtest.sh which
+allows for simulating, reconstructing and making the
+invariant analysis of the generated Upsilon (1S).
+The used configuration file is Config.C in MUON
+directory.
+
+You have to type :
+<pre>
+$ALICE_ROOT/MUON/AlirootRun_MUONtest.sh [option]
+</pre>
+
+The complete list of the option is printed when you call
+the script with whatever non valid option, .eg. h:
+
+<pre>
+./AlirootRun_MUONtest.sh h
+ERROR : extra option not recognized
+Usage: AlirootRun_MUONtest.sh options (-SRXsrxn:tg:p:d:c:)
+ -S (-s) perform (or not) simulation (default is do it, i.e -S)
+ -R (-r) perform (or not) reconstruction (default is do it, i.e. -R)
+ -X event (-x) perform (or not) checks and dumps (default is do it for event 5, i.e. -X 5)
+ -n nevents (int) number of events to simulate (default 100)
+ -t will use OUTDIR as a tmp directory to generate raw data
+ -g seed (uint) seed to be used in simulation (default 1234567)
+ -p recoptions (quotified string) reconstruction options to use (default "SAVEDIGITS")
+ -d full path to output directory (default /work/projects/alice/trunk/AliRoot/MUON/test_out.100)
+ -c full path to configuration file for simulation (default /work/projects/alice/trunk/AliRoot/MUON/Config.C)
+</pre>
+
+The results of this test are saved in test_out.nevent directory.
+Please note that the CDB (Condition DataBase) is now always *required*
+to perform either simulation or reconstruction. For the moment, a version
+of that CDB is stored in CVS, so you should have one already in MUON/Calib
+subdirectories.
+
+
+\section s2 How to check that your aliroot is working VERY well
+
+There is a script file AlirootRun_MUONlongtest.sh which
+allows for simulating, reconstructing and making the
+-+invariant analysis of the generated Upsilon (1S).
+This script generates a large number of Upsilon (20k)
+in order to access differential quantities.
+The used configuration file is Config.C in MUON
+directory.
+
+One should really run this script to check if the MUON
+code can process a large number of events WITHOUT errors,
+in particular before making important commits !!
+
+You have to type :
+<pre>
+$ALICE_ROOT/MUON/AlirootRun_MUONtestlong.sh
+</pre>
+The results of this test are saved in testlong_out/ directory
+and will be kept in CVS
+
+(NOTE: the macros performing the calculations/plots MUONefficiency.C
+and MUONplotefficiency.C are also able to handle J/Psi if
+Config.C is modified accordingly )
*/
git://git.uio.no / u / mrichter / AliRoot.git / blobdiff