Alignment/OfflineValidation/README_IOV.md

0001 The following document summarises usage of IOV/run-driven validations.
0002
0003 ## DMR and PV
0004
0005 Example A:
0006 ```
0007 validations:
0008     DMR:
0009         single:
0010             TestSingleMC:
0011                 IOV:
0012                     - 1
0013                 dataset: /path/to/dataset.txt
0014                 ...
0015             TestSingleDataIOV:
0016                 IOV:
0017                     - 315257
0018                     - 315488
0019                     - 315489
0020                 dataset: /path/to/dataset_IOV_{}.txt
0021                 goodlumi: /path/to/IOV_Vali_{}.json
0022             TestSingleDataRun:
0023                 IOV:
0024                     - 315257
0025                     - 315258
0026                     - 315259
0027                     ...
0028                     - 315488
0029                 dataset: /path/to/dataset_Run_{}.txt
0030                 goodlumi: /path/to/Run_Vali_{}.json
0031             TestSingleDataFromFile:
0032                 IOV: /path/to/listOfRunsOrIOVs.txt
0033                 dataset: /path/to/listOfAllFiles.txt
0034 ```
0035 TestSingleMC: Run number 1 is reserved for MC objects only.
0036 TestSingleDataIOV/Run: In case of data, selected numbers can represent both IOV and run numbers. Luminosity is assigned from 'goodlumi' json file where you can define if number should be understood as IOV or single run. Lumiblock structure should also be defined, see Example: `/afs/cern.ch/cms/CAF/CMSALCA/ALCA_TRACKERALIGN/MP/MPproduction/datasetfiles/UltraLegacy/Run2/forDMRweighted/MuonIsolated2018_new/IOV_Vali_320933.json` defines IOV=320933 consisting o 3 runs.
0037 TestSingleDataFromFile: If list of IOVs/Runs is too long, you can provide it in a form of plain txt list (one number for each line). Dataset file can also contain all input file names (no curly brackets), however it is NOT recommended as it makes jobs much longer.
0038
0039 Example B:
0040 ```
0041 trends:
0042     Run2trend:
0043         singles:
0044             - Run2018B
0045         firstRun: 317087
0046         lastRun: 317212
0047 ```
0048 When defining trend job you can also specify starting and ending run to be plotted.
0049
0050 ```
0051 style:
0052     PV:
0053         merge:
0054             CMSlabel: Preliminary
0055     trends:
0056         CMSlabel: Internal
0057         Rlabel: 2018B
0058         lumiInputFile: /path/to/lumiperIOV.txt
0059 ```
0060 `lumiInputFile` is used for trend plotting step only and it defines integrated luminosity for each IOV/run considered. It needs to be a plain format with two columns (<run> <lumi>). Following schemes are supported:
0061
0062 ```
0063 RUN 1 <space> lumi for the only run in IOV 1
0064 ...
0065 RUN 4 <space> lumi for the starting run (4) of IOV 4
0066 RUN 5 <space> lumi for another run (5) of IOV 4
0067 RUN 6 <space> lumi for another run (6) of IOV 4
0068 ```
0069
0070 or
0071
0072 ```
0073 IOV 1 <space> lumi for all runs in IOV 1, in this case could be just one run
0074 ...
0075 IOV 4 <space> lumi for all runs in IOV 4, in this case sum of lumi for RUN 4,5 and 6
0076 ```