mcepeda / finalstateanalysis

CMS analysis framework

FinalStateAnalysis Package Description

The Final State Analysis (FSA) package is a CMSSW analysis framework.
The package contains a complete implementatation to build a POG-approved PAT tuple, and utilities for generating plain ROOT ntuples from the PAT tuple.

Documentation: https://github.com/uwcms/FinalStateAnalysis/wiki

Automated tests:

53X PAT + Ntuple
42X PAT + Ntuple
53X Ntuple Only

Installation

Current CMSSW versions: 4_2_8_patch7 or 5_3_9.
The installation instructions are the same for both.

Get a supported CMSSW release area::

  scram pro -n MyWorkingAreaName CMSSW CMSSW_VERSION

Checkout the FinalStateAnalysis repository::

  cd MyWorkingAreaName/src
  git clone --recursive https://github.com/uwcms/FinalStateAnalysis.git
  cd FinalStateAnalysis

This will checkout the lastest and greatest version of the code. You might also want the Summer 2013 compatible branch, if so you should additionally run:

git checkout summer2013

and then proceed as normal.

Checkout the needed CMSSW tags:

  cd recipe/
  # You need to have CVS access
  kinit [email protected]
  # Make sure your CMSSW environment is set up
  cmsenv
  # Checkout needed packages and apply patches
  # This enables all options.  You can turn off things you don't need.
  # NB that in the hcp2012 changes the options won't do anything.
  PATPROD=1 LUMI=1 LIMITS=1 ./recipe.sh
  # Compile
  cd ../../
  scram b -j 8

You must always set up the CMSSW environment + some extra variables from FinalStateAnalysis::

  cmsenv
  source $CMSSW_BASE/src/FinalStateAnalysis/environment.sh

For python plotting enhancements, install the custom python virtualenv and extra packages (note this is not necessary for PAT tuple production)::

  ./install_python.sh
  yolk -l # List installed packages