Skip to content

Commit

Permalink
add documentation for Generic Validation
Browse files Browse the repository at this point in the history
  • Loading branch information
mmusich committed Jan 8, 2025
1 parent 90f0024 commit b6031b0
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 0 deletions.
6 changes: 6 additions & 0 deletions Alignment/OfflineValidation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,5 +117,11 @@ For details read [`README_JetHT.md`](https://github.com/cms-sw/cmssw/blob/master
## MTS validation
For details read [`README_MTS.md`](https://github.com/cms-sw/cmssw/blob/master/Alignment/OfflineValidation/README_MTS.md)

## Pixel BaryCenter
For details read [`README_MTS.md`](https://github.com/cms-sw/cmssw/blob/master/Alignment/OfflineValidation/README_PixBary.md)

## Generic validation (dataset validation)
For details read [`README_Generic.md`](https://github.com/cms-sw/cmssw/blob/master/Alignment/OfflineValidation/README_Generic.md)

## General info about IOV/run arguments
For details read [`README_IOV.md`](https://github.com/cms-sw/cmssw/blob/master/Alignment/OfflineValidation/README_IOV.md)
39 changes: 39 additions & 0 deletions Alignment/OfflineValidation/README_Generic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Generic Validation

## General info
```
validations:
Generic:
<step_type>:
<step_name>:
<options>
```

Generic validation runs in 2 possible types of steps:
- single (validation analysis by GenericV_cfg.py)
- (optional) merge (GenericVmerge macro)
Step name is and arbitrary string which will be used as a reference for consequent steps.
Merge job awill only start if all corresponding single jobs are done.
Merge jobs can run in parallel.

## Single Generic jobs
Single jobs can be specified per run (IoV as well). In case of MC, IoV is specified to arbitrary 1.

Variable | Default value | Explanation/Options
-------- | ------------- | --------------------
IOV | None | List of IOVs/runs defined by integer value. IOV 1 is reserved for MC.
Alignments | None | List of alignments. Will create separate directory for each.
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).
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`
maxevents | 1 | Maximum number of events before cmsRun terminates.
trackcollection | "generalTracks" | Track collection to be specified here, e.g. "ALCARECOTkAlMuonIsolated" or "ALCARECOTkAlMinBias" ...
tthrbuilder | "WithAngleAndTemplate" | Specify TTRH Builder

## Merge Generic job
Its name do not need to match single job name but option `singles` must list all single jobs to be merged.
Generic merged plot style can be adjusted from global plotting style.

Variable | Default value | Explanation/Options
-------- | ------------- | --------------------
singles | None | List of strings matching single job names to be merged in one plot.
customrighttitle | "" | Top right title. Reserved word "IOV" will be replaced for given IOV/run in the list.

0 comments on commit b6031b0

Please sign in to comment.