ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/UserCode/UHHAnalysis/Mainpage
Revision: 1.1
Committed: Wed Jun 13 14:40:11 2012 UTC (12 years, 10 months ago) by peiffer
Branch: MAIN
Log Message:
mainpage for doxygen documentation

File Contents

# User Rev Content
1 peiffer 1.1 /*! \mainpage UHHAnalysis Package
2     *
3     * \section intro_sec Introduction
4     *
5     * This page describes the UHHAnalysis package. The UHHAnalysis package consists of two parts:
6     *
7     * <UL>
8     * <LI><STRONG>NtupleWriter:</STRONG> A CMSSW module that transforms PAT event content into a compressed data format.</LI>
9     *
10     * <LI><STRONG>SFrameAnalysis/SFrameTools:</STRONG> Collection of analysis modules based on the <A HREF="http://sourceforge.net/apps/mediawiki/sframe/index.php?title=Main_Page">SFrame package</A> to anaylze samples produced with the NtupleWriter.</LI>
11     * </UL>
12     *
13     * \section install_sec Installation
14     *
15     * \subsection step1 Installation of NtupleWriter
16     *
17     * First, you need to install CMSSW:
18     *
19     * <CODE> scram project CMSSW CMSSW_5_2_5</CODE><BR>
20     * <CODE> cd CMSSW_5_2_5/src </CODE><BR>
21     * <CODE> cmsenv </CODE><BR>
22     *
23     * Check-out the NtupleWriter and compile:
24     *
25     * <CODE> cvs co -d UHHAnalysis/NtupleWriter UserCode/UHHAnalysis/NtupleWriter</CODE><BR>
26     * <CODE> scram b</CODE><BR>
27     *
28     *
29     * \subsection step2 Installation of SFrameAnaylsis
30     *
31     * Make sure that you have a <A HREF="http://root.cern.ch">ROOT</A> environment set up (SFrameAnaylsis has been tested with ROOT 5.30 or higher).
32     *
33     * You need an installation of <A HREF="http://fastjet.fr/">fastjet</A> version 3.0.2 on your machine.
34     *
35     * Add the fastjet library to your LD_LIBRARY_PATH:
36     *
37     * <CODE> export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<YOUR-PATH-TO_FASTJET>/fastjet-3.0.2/install/lib</CODE>
38     *
39     * Install the SFrame package:
40     *
41     * <CODE> svn co https://sframe.svn.sourceforge.net/svnroot/sframe/SFrame/tags/SFrame-03-05-16 SFrame </CODE><BR>
42     * <CODE> cd SFrame </CODE><BR>
43     * <CODE> source setup.sh </CODE><BR>
44     * <CODE> make </CODE>
45     *
46     * Check out the packages SFrameAnalysis and SFrameTools from the UHHAnalysis package:
47     *
48     * <CODE> cvs co -d SFrameAnalysis UserCode/UHHAnalysis/SFrameAnalysis</CODE><BR>
49     * <CODE> cvs co -d SFrameTools UserCode/UHHAnalysis/SFrameTools</CODE><BR>
50     *
51     * Change the fastjet paths in the two Makefiles <CODE>SFrameAnalysis/Makefile</CODE> and <CODE>SFrameTools/Makefile</CODE> to your local fastjet installation.
52     *
53     * Check out the Objects directory and compile all sub-packages:
54     *
55     * <CODE> cd SFrameTools/include </CODE><BR>
56     * <CODE> cvs co -d Objects UHHAnalysis/NtupleWriter/Objects </CODE><BR>
57     * <CODE> cd .. </CODE><BR>
58     * <CODE> make </CODE><BR>
59     * <CODE> cd JetMETObjects </CODE><BR>
60     * <CODE> export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:${SFRAME_DIR}/SFrameTools/JetMETObjects/lib </CODE><BR>
61     * <CODE> make </CODE><BR>
62     * <CODE> cd ../../SFrameAnalysis</CODE><BR>
63     * <CODE> make </CODE><BR>
64     *
65     *
66     */