Instructions how to download CMS luminosity and bunch intensities for a given LHC fill

BRIL (Beam Radiation Instrumentation and Luminosity) is a new project within CMS introduced after LS1: "it comprises all subdetectors for the measurement of the luminosity, monitoring of the beam conditions, and protection of CMS from serious radiation damage"

There are currently two CMS scripts which provides CMS luminosity calibrated using VDM scans (separation scans):

1. lumiCalc2.py for lumi data before LS1 (LHC Run1)
2. and newer brilcalc (part of brilws) for data after LS1 (LHC Run2) which should support also LHC Run1 lumi data at some point

How to download luminosity for runs BEFORE LS1

See users guide of lumiCalc2.py on CMS Twiki (lumiCalc2.py requires CMSSW + one extra module and provides only HF lumi)

Example

lumiCalc2.py -o fill_2836_lumiCalc2.py_V04-02-10_lumibylsXing.csv -f 2836 lumibylsXing --xingMinLum -1

How to download luminosity and beam/bunch intensities for runs AFTER LS1

CMS doc to brilws (look at it before continuing): http://cms-service-lumi.web.cern.ch/cms-service-lumi/brilwsdoc.html

brilws release notes: http://cms-service-lumi.web.cern.ch/cms-service-lumi/releaserss.xml

In short in the simplest case (look to the doc for more details, options and up to date comments):

1) login to lxplus:

ssh -Y <user>@lxplus.cern.ch

2) run (adjust to your real running setup accordingly, the following will uninstall current version of brilws and install the latest one, X.Y.Z should be the latest brilconda version, see http://cms-service-lumi.web.cern.ch/cms-service-lumi/brilwsdoc.html)

export PATH=$HOME/.local/bin:/afs/cern.ch/cms/lumi/brilconda-X.Y.Z/bin:$PATH
pip uninstall -y brilws
pip install --install-option="--prefix=$HOME/.local" brilws
pip show brilws

Examples

• lumi info

for a given fill number may be downloaded as:

     brilcalc lumi -f 4489 --xing -o fill_4489_brilcalc_lumi_xing.csv
     

which may provide only some BCIDs. To download some lumi values for all BCIDs you may try HF detector (dedicated to mainly online measurement):

     brilcalc lumi -f 4489 --xing -o fill_4489_brilcalc_lumi_xing.csv --type hfoc
     

To select just some BCIDs (e.g., 41,1826,901,932):

     brilcalc lumi -f 4489 --xing --xingId "41,1826,901,932" --xingMin 1e-100 -o fill_4489_brilcalc_lumi_xing_ids.csv  --type hfoc
     

• beam/bunch intensities

may be downloaded as:

      brilcalc beam -f 4489 --xing -o fill_4489_brilcalc_beam_xing.csv
      

Important note

The above instructions should help to get fast some lumi data. For more advanced analyses it is necessary to ask CMS which lumi should be used for given TOTEM runs and what is the corresponding uncertainty etc (some corrections or calibration may require some more time for offline analysis and may come much later). The downloaded file with lumi values includes in header also some meta information (data tag and norm tag - "version") which is very useful for later usage - to keep track of the version, lumi values serving as an input for an physics analysis (=>save and keep the file).

CMS lumi/bril mailing list: hn-cms-luminosity@cernNOSPAMPLEASE.ch

Timber variables for bunch intensities (for beam 1 and beam 2 separatelly)

LHC:BCTFR.A6R4.B1:BUNCH_INTENSITY
LHC:BCTFR.A6R4.B2:BUNCH_INTENSITY

or (there are two systems "A" and "B" which should report consistent values; or at least one system should work)

LHC:BCTFR.B6R4.B1:BUNCH_INTENSITY
LHC:BCTFR.B6R4.B2:BUNCH_INTENSITY

a csv file for a given fill number and each beam may be downloaded using Timber. This is an "online" alternative to offline "brilcalc beam" to retrieve bunch intensitites for each beam.

Some usefull links

CMS Luminosity - public results

https://twiki.cern.ch/twiki/bin/view/CMSPublic/LumiPublicResults#2015_Proton_Proton_Collisions

Simple lumi calculator

https://lpc.web.cern.ch/lpc/lumi.html

General information about luminosity calibration at the LHC (mostly outdated but contains links about concept of luminosity etc) http://lpc.web.cern.ch/lpc/lumicalib.htm

Brilview

Documentation: http://brilview.readthedocs.io

Central deployment: https://brilview.web.cern.ch

Terminology

BCID/BXID - bunch crossing ID (CMS stars from 1, TOTEM from 0 - check it)

SBIL - single bunch instantaneous luminosity

LS - lumi section or lumi block (~23.3sec)

Miscalaneous

TOTEM fills without stable beams: in 2015: 3838, 3844, 3952 (no lumi available), 4489

CMS lumi callibration in 2015 (pp@13TeV): http://cds.cern.ch/record/2138682

LHC Programme Coordination

Filling Scheme Editor

Filling Schemes

Java Filling schemes viewer

pytimber

-- JiriProchazka - 2015-10-28