Update beamspot option in ConfigBuilder

[francescobrivio]

PR description:

Addressing issue #47182.

In this PR I'm updating the ConfigBuilder script to make sure that an exception is raised in case a cmsDriver command for MC is launched without the --beamspot parameter in the GEN step.
Additionally I:

• Unified the VtxSmearedDefaultKey and VtxSmearedHIDefaultKey default values to be DBrealistic
• Updated the TSG MC addOnTests with --beamspot DBrealistic
• Updated the PREMIX workflow steps that were missing the --beamspot option

PR validation:

I have tested this PR in multiple conditions (Data,MC) x (pp,HI,cosmics) and verified that it behaves as expected with:

runTheMatrix.py -l 16834.0,312.0,8.0,145.713,4.22,142.0 -j 12 --ibeos
addOnTests.py

Additionally I verified that the command:

cmsDriver.py Configuration/GenProduction/python/GEN-Run3Winter25wmLHEGS-00006-fragment.py \
  --python_filename test_1_GS_MC.py \
  --eventcontent RAWSIM,LHE --customise Configuration/DataProcessing/Utils.addMonitoring \
  --datatier GEN-SIM,LHE --fileout file:GEN-Run3Winter25wmLHEGS-00006.root \
  --conditions 142X_mcRun3_2025_realistic_v4 \
  --customise_commands process.RandomNumberGeneratorService.externalLHEProducer.initialSeed="int(${SEED})"\\nprocess.source.numberEventsInLuminosityBlock="cms.untracked.uint32(100)" \
  --step LHE,GEN,SIM --geometry DB:Extended \
  --era Run3_2024 --no_exec --mc -n 1

(where the --beamspot option is missing) raises the following exception:

LHE,GEN,SIM,ENDJOB
Traceback (most recent call last):
  File "/afs/cern.ch/work/f/fbrivio/beamSpot/2025/fix_default_VtxSmearing/CMSSW_15_0_X_2025-01-26-0000/bin/el9_amd64_gcc12/cmsDriver.py", line 40, in <module>
    run()
  File "/afs/cern.ch/work/f/fbrivio/beamSpot/2025/fix_default_VtxSmearing/CMSSW_15_0_X_2025-01-26-0000/bin/el9_amd64_gcc12/cmsDriver.py", line 14, in run
    configBuilder = ConfigBuilder(options, with_output = True, with_input = True)
  File "/afs/cern.ch/work/f/fbrivio/beamSpot/2025/fix_default_VtxSmearing/CMSSW_15_0_X_2025-01-26-0000/src/Configuration/Applications/python/ConfigBuilder.py", line 258, in __init__
    self.define_Configs()
  File "/afs/cern.ch/work/f/fbrivio/beamSpot/2025/fix_default_VtxSmearing/CMSSW_15_0_X_2025-01-26-0000/src/Configuration/Applications/python/ConfigBuilder.py", line 1064, in define_Configs
    raise Exception("Missing \'--beamspot\' option in the cmsDriver command!")
Exception: Missing '--beamspot' option in the cmsDriver command!

Backport:

Not a backport, but backports can be opened in case @cms-sw/pdmv-l2 experts think it could be useful.

[cmsbuild]

cms-bot internal usage

[cmsbuild]

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-47188/43427

• There are other open Pull requests which might conflict with changes you have proposed:
  • File Configuration/Applications/python/ConfigBuilder.py modified in PR(s): [Phase-2 L1] Incorporate object threshold scalings, ID and isolation via dictionaries into the P2GT menu #46489

[cmsbuild]

A new Pull Request was created by @francescobrivio for master.

It involves the following packages:

• Configuration/Applications (operations)

@antoniovilela, @cmsbuild, @davidlange6, @fabiocos, @mandrenguyen, @rappoccio can you please review it and eventually sign? Thanks.
@Martin-Grunewald, @fabiocos, @makortel, @missirol this is something you requested to watch as well.
@antoniovilela, @mandrenguyen, @rappoccio, @sextonkennedy you are the release manager for this.

cms-bot commands are listed here

[Martin-Grunewald]

Hmm well, this PR will render unusable any/all cmsDriver commands not specifying a beamspot. While that is arguable great for costly MC production, for many technical tests this just creates work to fix. Anyway, can you please suggest here a valid (default?) beamspot parameter for generic use?

[francescobrivio]

Hmm well, this PR will render unusable any/all cmsDriver commands not specifying a beamspot.

Hi Martin, here you mean all steps after GEN-SIM right? Because GS step should always specify a beamspot.
Or are there other cases I'm not aware of?

In any case, I will update the PR to provide a default --beamspot value for steps >= GEN-SIM.

[Martin-Grunewald]

We have some (technical) TSG tests using cmsDriver which now fail, post GEN-SIM, such as with cmsDriver steps:

DIGI:pdigi,L1,DIGI2RAW,ENDJOB
DIGI:pdigi,L1,DIGI2RAW,HLT:GRun,ENDJOB
HLT:GRun,ENDJOB
HLT:GRun,RAW2DIGI,L1Reco,RECO,ENDJOB
RAW2DIGI,L1Reco,RECO,PAT,VALIDATION,DQM

[Martin-Grunewald]

We also have some GEN-SIM steps here where we would need a generic beamspot parameter now:
https://github.com/cms-sw/cmssw/blob/master/Configuration/HLT/python/addOnTestsHLT.py

[mmusich]

Anyway, can you please suggest here a valid (default?) beamspot parameter for generic use?

I think we should just add:

--beamspot DBrealistic to the commands in the TSG addOnTests and we should be OK.

[mmusich]

Or, we could just change the default in

cmssw/Configuration/StandardSequences/python/VtxSmeared.py

Line 79 in 75451d5

VtxSmearedDefaultKey='Realistic50ns13TeVCollision'

as suggested at #47182 (comment) as option 1. (which I quite frankly prefer).

[francescobrivio]

Thanks @Martin-Grunewald and @mmusich !
What I'm doing right now is to:

• make sure the exception is raised in ConfigBuilder only if the step is GEN-SIM
• Change the VtxSmearedDefaultKey to be DBrealistic

This would still mean that the addOnTests need to be updated...Marco, Martin I could include it in this PR if you want, just let me know.

[Martin-Grunewald]

Please make the change in this PR as the addOn tests are run by the PR testing bot.

[cmsbuild]

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-47188/43429

• There are other open Pull requests which might conflict with changes you have proposed:
  • File Configuration/Applications/python/ConfigBuilder.py modified in PR(s): [Phase-2 L1] Incorporate object threshold scalings, ID and isolation via dictionaries into the P2GT menu #46489

[cmsbuild]

Pull request #47188 was updated. @Martin-Grunewald, @antoniovilela, @cmsbuild, @davidlange6, @fabiocos, @mandrenguyen, @mmusich, @rappoccio can you please check and sign again.

[Martin-Grunewald]

Hmm, I guess VtxSmearedHIDefaultKey should be kept - with the same new default?

[cmsbuild]

Pull request #47188 was updated. @AdrianoDee, @Martin-Grunewald, @Moanwar, @antoniovilela, @cmsbuild, @davidlange6, @DickyChant, @fabiocos, @mandrenguyen, @miquork, @mmusich, @rappoccio, @srimanob, @subirsarkar can you please check and sign again.

[mmusich]

@cmsbuild, please test

[cmsbuild]

+1

Size: This PR adds an extra 92KB to repository
Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-37b57c/43998/summary.html
COMMIT: 142a0ab
CMSSW: CMSSW_15_0_X_2025-01-27-2300/el8_amd64_gcc12
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week0/cms-sw/cmssw/47188/43998/install.sh to create a dev area with all the needed externals and cmssw changes.

Comparison Summary

Summary:

• You potentially added 1 lines to the logs
• Reco comparison results: 8 differences found in the comparisons
• DQMHistoTests: Total files compared: 50
• DQMHistoTests: Total histograms compared: 3994126
• DQMHistoTests: Total failures: 6
• DQMHistoTests: Total nulls: 0
• DQMHistoTests: Total successes: 3994100
• DQMHistoTests: Total skipped: 20
• DQMHistoTests: Total Missing objects: 0
• DQMHistoSizes: Histogram memory added: 0.0 KiB( 49 files compared)
• Checked 218 log files, 189 edm output root files, 50 DQM output files
• TriggerResults: no differences found

[mmusich]

+hlt

• for Update beamspot option in ConfigBuilder #47188 142a0ab
• somewhat technical, now TSG addOnTests make use of the correct gen-level vertex smearing (assuming it's correctly implemented in the Global Tag)

[Moanwar]

+Upgrade

[francescobrivio]

a kind ping @cms-sw/pdmv-l2

[AdrianoDee]

+pdmv
(and thanks @francescobrivio)

[cmsbuild]

This pull request is fully signed and it will be integrated in one of the next master IBs (tests are also fine). This pull request will now be reviewed by the release team before it's merged. @antoniovilela, @sextonkennedy, @rappoccio, @mandrenguyen (and backports should be raised in the release meeting by the corresponding L2)

[mandrenguyen]

+1