mainpage.h

Go to the documentation of this file.
00001 
00002 
00003 
00004 /*! \mainpage HepMCAnalysis Tool 3.4.11
00005 @author Cano Ay, Wolfgang Ehrenfeld, Sebastian Johnert, Judith Katzy, Sebastian Piec, Zhonghua Qin
00006   
00007       August 2011
00008  *
00009  * \section intro_sec Introduction
00010  HepMCAnalyser is a tool for generator validation and comparisons.
00011 The main idea is to have a stable, easy-to-use and extendable framework to
00012  provide a fast access point to generator level analysis.
00013 
00014 A class library with benchmark physics processes has been written to analyse
00015  HepMC  generator output and fill root histogramms. The source code of the 
00016 classes is in the HepMCAnalysis/include and src directories.
00017 
00018 
00019 A web-interface is provided to display all or selected histogramms, compare
00020 to references and validate the results based on Kolmogorov Tests. These 
00021 scripts are in HepMCAnalysis/examples/macros
00022 
00023 
00024 Steerable example programs can be used for event generation and conversion to
00025 HepMC format. The steering it tuned to produce best agreement between the
00026   distributions of the different generators. The programms are in HepMCAnalysis/examples/generatorX where generatorX stands e.g. for pythia6, pythia8, herwigpp... .
00027 
00028 
00029   
00030  
00031   \section install_sec Installation
00032  
00033 The tool is supported on the same platforms as the GENSER library. It links 
00034 against the GENSER installation. It will automatically detect the CERN or the 
00035 DESY mirror of the GENSER libraries.
00036 
00037 For installation do the following:
00038 
00039 1.: cd HepMCAnalysis
00040 
00041 2.: source setup.sh         //setup the environment, link to genser libs
00042 
00043 3.: make slib              // creates the shared lib of the analysis classes
00044 
00045    \section run_sec Running
00046 
00047 For running go in the directory of the generator you want to check and 
00048 perform the following steps:
00049  1.: cd examples/pythia6  //here we give the example for pythia, other generators follow the same schema
00050 
00051 2.: make -f Makefile_pythia6 pythia6  // creates the pythia6 executable, see README for details
00052 
00053 3.: ./pythia6.exe Process.Config     // generates pythia events and analyse them with class lib, write out histgramms in a root file
00054 
00055  */

Generated on Wed Aug 31 09:44:47 2011 for HepMCAnalysis by  doxygen 1.4.7