L1 Trigger Emulator Stage 1 Upgrade Instructions

This is a set of instructions on how to run the new Stage-1 upgrade version of the L1 Emulator to produce rates and efficiencies. For developer information, please see SWGuideL1TOfflineDev.

Environment Setup

The Stage1 emulator is now included in the official CMSSW. Listed below are instructions for running in CMSSW_7_3_0, though they should hold for any recent release:

 
$ setenv SCRAM_ARCH slc6_amd64_gcc491
$ cmsrel CMSSW_7_3_0
$ cd CMSSW_7_3_0/src
$ cmsenv
$ git cms-addpkg L1Trigger/L1TCalorimeter
$ scram build -j 4

$$$ If "git cms-addpkg" returns the error "fatal: destination path ... already exists and is not an empty directory", you can perform the following gymnastics:
$ mkdir ~/src_temp
$ mv * ~/src_temp/
$ git cms-addpkg L1Trigger/L1TCalorimeter
$ mv ~/src_temp/* .
$ rmdir ~/src_temp
$$$ If anyone knows the "right" way to do this in git, please revise these instructions 

Running the Emulator

To run the emulator on a given dataset, edit the file

L1Trigger/L1TCalorimeter/test/SimL1Emulator_Stage1.py

so that it points at an available dataset. Then, run the configuration with

$ cmsRun L1Trigger/L1TCalorimeter/test/SimL1Emulator_Stage1.py

This will produce an EDM file which by default is named "SimL1Emulator_Stage1_PP.root". You can inspect the configuration online here.

Tunable Parameters

Tunable parameters are configured in the file L1Trigger/L1TCalorimeter/python/caloStage1Params_cfi.py. Below is a table describing the physical meanings behind some of the more important parameters.

Computing Rates

Once you have produced an output file, you can compute the relative rates very easily by drawing from the available trees. For instance, if you'd like to draw the rate as a function of threshold for the inclusive single jet trigger, you could use a macro like this:

  const int PT_MAX = 120;
  const int nPTBINS = PT_MAX/4; // Jets are on a 4 GeV scale

  TFile *infile = TFile::Open("SimL1Emulator_Stage1.root");
  TTree *events = (TTree*)infile->Get("Events");
  TH1D *pt = new TH1D("pt",";L1 Jet p_{T} (GeV);Count",nPTBINS,0,PT_MAX);
  events->Project(pt->GetName(), "l1tJetBXVector_caloStage1FinalDigis__L1TEMULATION.obj.data_.l1t::L1Candidate.pt()[0][0]");
  TH1D *rate = new TH1D("rate",";L1 Jet p_{T} (GeV);Rate (Arb.)",
                              nPTBINS,0,PT_MAX);
  double total_integral = pt->Integral(0,nPTBINS+1);
  for(int i = 0; i < nPTBINS; i++)
  {
    double j = (double)i*(double)PT_MAX/(double)nPTBINS;
    double integral = pt->Integral(i, nPTBINS+1);
    rate->Fill(j, (double)integral/total_integral);
  }
  rate->Draw();

Alternatively, you can use the output of the L1TriggerDPG, as used in the Computing Efficiencies section below.

Computing Efficiencies

$ git clone https://github.com/cms-l1-dpg/L1Ntuples.git L1TriggerDPG/L1Ntuples
$ git clone https://github.com/cms-l1-dpg/L1Menu.git L1TriggerDPG/L1Menu
$ scram build -j4
$ cd L1TriggerDPG/L1Menu/test
$ cmsRun customL1NtupleFromRaw.py reEmulation=True reEmulMuons=True reEmulCalos=True patchNtuple=True force2012Config=True customDTTF=True dttfLutsFile=sqlite:../data/dttf_config.db globalTag=POSTLS162_V2::All runOnMC=True runOnPostLS1=True useStage1Layer2=True

Recipe for Running the L1 Stage1 Emulator in the HLT

Recipe for 720pre8 hide

rehash  # (hash -r if using bash shell) 
hltGetConfiguration /dev/CMSSW_7_2_0/GRun/V11 --full --offline --mc --unprescale --process TEST --globaltag GlobalTag --l1-emulator 'stage1,gt' --l1Xml L1Menu_Collisions2015_25ns_v1_L1T_Scales_20101224_Imp0_0x102f.xml > hlt_stage1.py
cmsRun hlt_stage1.py >& runTest.log &

Recipe for 720pre7 hide

cmsrel CMSSW_7_2_0_pre7
cd CMSSW_7_2_0_pre7/src
cmsenv
git cms-merge-topic --unsafe cms-l1t-offline:Emulator_1.5
scram b -j7
rehash  # (hash -r if using bash shell) 
hltGetConfiguration /dev/CMSSW_7_2_0/GRun/V11 --full --offline --mc --unprescale --process TEST --globaltag PRE_LS172_V16 --l1-emulator 'stage1,gt' --l1Xml L1Menu_Collisions2015_25ns_v1_L1T_Scales_20101224_Imp0_0x102f.xml > hlt_stage1.py &
cmsRun hlt_stage1.py >& runTest.log &

from SLHCUpgradeSimulations.Configuration.postLS1Customs import *
process = customise_HLT( process )

Recipe for 720pre6 hide

cmsrel CMSSW_7_2_0_pre6
cd CMSSW_7_2_0_pre6/src
cmsenv
git cms-merge-topic --unsafe cms-l1t-offline:Stage1plusHLT_V0
scram b -j7
rehash  # (hash -r if using bash shell) 
cp L1Trigger/L1TCommon/data/dttf_config.db $PWD  ## for now, this file must reside in the directory you will ultimately run from
hltGetConfiguration /dev/CMSSW_7_1_2/GRun/V15 --full --offline --mc --unprescale --process TEST --globaltag auto:upgradePLS1 --l1-emulator 'stage1,gt' > hlt_stage1.py
cmsRun hlt_stage1.py >& runTest.log &

from SLHCUpgradeSimulations.Configuration.postLS1Customs import *
process = customise_HLT( process )

cd $CMSSW_BASE/src
git cms-addpkg L1TriggerConfig/L1GtConfigProducers
cp -a /afs/cern.ch/user/g/ghete/public/L1Menu/L1Menu_Collisions2015_25ns_v1/xml/Rev.1.1/L1Menu_Collisions2015_25ns_v1_L1T_Scales_20101224_Imp0_0x102f.xml L1TriggerConfig/L1GtConfigProducers/data/Luminosity/startup/

hltGetConfiguration /dev/CMSSW_7_2_0/GRun/V11 --full --offline --mc --unprescale --process TEST --globaltag auto:upgradePLS1 --l1-emulator 'stage1,gt' --l1Xml L1Menu_Collisions2015_25ns_v1_L1T_Scales_20101224_Imp0_0x102f.xml > hlt_stage1_newL1Menu.py

-- RichardBarbieri - 26 May 2014