Skip to content

Commit b6031b0

Browse files
committed
add documentation for Generic Validation
1 parent 90f0024 commit b6031b0

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

Alignment/OfflineValidation/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,5 +117,11 @@ For details read [`README_JetHT.md`](https://github.com/cms-sw/cmssw/blob/master
117117
## MTS validation
118118
For details read [`README_MTS.md`](https://github.com/cms-sw/cmssw/blob/master/Alignment/OfflineValidation/README_MTS.md)
119119

120+
## Pixel BaryCenter
121+
For details read [`README_MTS.md`](https://github.com/cms-sw/cmssw/blob/master/Alignment/OfflineValidation/README_PixBary.md)
122+
123+
## Generic validation (dataset validation)
124+
For details read [`README_Generic.md`](https://github.com/cms-sw/cmssw/blob/master/Alignment/OfflineValidation/README_Generic.md)
125+
120126
## General info about IOV/run arguments
121127
For details read [`README_IOV.md`](https://github.com/cms-sw/cmssw/blob/master/Alignment/OfflineValidation/README_IOV.md)
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Generic Validation
2+
3+
## General info
4+
```
5+
validations:
6+
Generic:
7+
<step_type>:
8+
<step_name>:
9+
<options>
10+
```
11+
12+
Generic validation runs in 2 possible types of steps:
13+
- single (validation analysis by GenericV_cfg.py)
14+
- (optional) merge (GenericVmerge macro)
15+
Step name is and arbitrary string which will be used as a reference for consequent steps.
16+
Merge job awill only start if all corresponding single jobs are done.
17+
Merge jobs can run in parallel.
18+
19+
## Single Generic jobs
20+
Single jobs can be specified per run (IoV as well). In case of MC, IoV is specified to arbitrary 1.
21+
22+
Variable | Default value | Explanation/Options
23+
-------- | ------------- | --------------------
24+
IOV | None | List of IOVs/runs defined by integer value. IOV 1 is reserved for MC.
25+
Alignments | None | List of alignments. Will create separate directory for each.
26+
dataset | See defaultInputFiles_cff.py | Path to txt file containing list of datasets to be used. If file is missing at EOS or is corrupted - job will eventually fail (most common issue).
27+
goodlumi | cms.untracked.VLuminosityBlockRange() | Path to json file containing lumi information about selected IoV - must contain list of runs under particular IoV with lumiblock info. Format: `IOV_Vali_{}.json`
28+
maxevents | 1 | Maximum number of events before cmsRun terminates.
29+
trackcollection | "generalTracks" | Track collection to be specified here, e.g. "ALCARECOTkAlMuonIsolated" or "ALCARECOTkAlMinBias" ...
30+
tthrbuilder | "WithAngleAndTemplate" | Specify TTRH Builder
31+
32+
## Merge Generic job
33+
Its name do not need to match single job name but option `singles` must list all single jobs to be merged.
34+
Generic merged plot style can be adjusted from global plotting style.
35+
36+
Variable | Default value | Explanation/Options
37+
-------- | ------------- | --------------------
38+
singles | None | List of strings matching single job names to be merged in one plot.
39+
customrighttitle | "" | Top right title. Reserved word "IOV" will be replaced for given IOV/run in the list.

0 commit comments

Comments
 (0)