Instructions for users

The correctionlib library needed to read the files from python or C++ lives on github, see its documentation for installation and usage instructions.

Some examples on how to the read the files are provided here in the examples folder. Also see these examples for how to use the library from a ROOT::RDataFrame application.

The latest files from the master branch from the main project are synced once a day to CVMFS at: /cvmfs/cms.cern.ch/rsync/cms-nanoAOD/jsonpog-integration (through CMSSDT Jenkins )

The content of all the available files is summarized on this webpage.

Inspecting the files manually can also be done using the command correction summary file.json.

Instructions for POGs to add corrections

<a href="./POG/">POG</a> folder in the repository

In this folder we store all the corrections. Each physics object has a separate json file, and each POG has a folder for storage.

To be taken care of:

1. different campaings are organized in folders with label "X_Y" i.e. (2016preVFP_UL, 2016postVFP_UL, 2017_UL, 2018_UL, 2018_EOY...)
2. each physics object in nanoAOD gets a separate json
3. the "inputs" labels should be unique and standardized, please have a look at the existing files
4. store the json in .gz format for compression
5. when changing the content of an existing correction (same name), make sure you increase its version number
6. for systematic variations, until they are better supported in correctionlib, please provide both the nominal and up/down variations of the corrections, not the uncertainties themselves.

Before making a merge request

• Configure the forked project from which you will be making a merge request, to properly run the test scripts:
  • Create a project access token in the forked repository Settings > Access Tokens: create a token with Reporter rights and api scope
  • Copy the token to a CI variable named GITLAB_API_TOKEN under the repository Settings > CI/CD > Variables
• Make sure you have rebased your branch on top of the latest master branch from the main project
• Validate the files you have added or modified using correction validate file.json

Automatic tests

Once a merge request is made, if the above has been done, the automatic tests will run. The tests will happen with the script defined here. Goal of the test:

• verify that the files are compliant to the JSON schema (currently v2).
• produce a summary to inspect the content of new files
• for modified files, produce a summary of the changes, and verify that corrections whose content changes have their version number increased.