Factory for adding UserHooks to PythiaHadronizer and SUEP decay pythia Hook

[cericeci]

PR description:

This PR includes two main changes:

• A mechanism to add UserHooks to Pythia8Hadronizer through the usage of a PluginFactory (thanks to @kpedro88 for the idea and pointers on how to), so the source code of the main pythia plugin does not need to be modified when adding user modifications. This idea can be used in the future to migrate the current implementation of several UserHooks that are currently hard-coded.

• A module dedicated to soft unclustered energy pattern (SUEP or soft-bombs)-like decays, following the description of 1612.00850. It can be used to decay an SM particle through a soft-bomb shower.

  • The suep shower code (header and source) is taken directly from Simon Knapen's implementation. As a consequence it does not follow cms' code standards. Should it be adapted as well?
  • The module uses the previously discussed PluginFactory to be included inside the Pythia8Hadronizer and can be used for decays of ME obtained from either pythia or a LHE producer such as madgraph. An example of its usage can be found here. It's usage is based on the inclusion of the following lines inside the process.generator inside the fragment:

        UserCustomization = cms.VPSet(
           cms.PSet(
             pluginName = cms.string("SuepDecay"),
             idDark = cms.int32(999999), # pdgId of the dark meson
             idMediator = cms.int32(25), # pdgId of the mediator
             temperature = cms.double(2) # Temperature of the thermal distribution
           )

PR validation:

Code-checks passed, unit tests passed.
Tests using a local config file show that the SUEP module properly decays the Higgs boson.

Backporting:

Once this is merged we aim for a backport to 10_6_X for UL MC production.

[cmsbuild]

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-36238/26871

• This PR adds an extra 32KB to repository

[cmsbuild]

A new Pull Request was created by @cericeci (Carlos Erice) for master.

It involves the following packages:

• GeneratorInterface/Pythia8Interface (generators)

@SiewYan, @mkirsano, @Saptaparna, @cmsbuild, @GurpreetSinghChahal, @agrohsje, @alberto-sanchez can you please review it and eventually sign? Thanks.
@alberto-sanchez, @mkirsano this is something you requested to watch as well.
@perrotta, @dpiparo, @qliphy you are the release manager for this.

cms-bot commands are listed here

[kpedro88]

please test

[cmsbuild]

+1

Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-0e55d9/20746/summary.html
COMMIT: 64c2e3b
CMSSW: CMSSW_12_2_X_2021-11-23-2300/slc7_amd64_gcc900
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week0/cms-sw/cmssw/36238/20746/install.sh to create a dev area with all the needed externals and cmssw changes.

Comparison Summary

Summary:

• No significant changes to the logs found
• Reco comparison results: 0 differences found in the comparisons
• DQMHistoTests: Total files compared: 42
• DQMHistoTests: Total histograms compared: 3247025
• DQMHistoTests: Total failures: 0
• DQMHistoTests: Total nulls: 0
• DQMHistoTests: Total successes: 3247003
• DQMHistoTests: Total skipped: 22
• DQMHistoTests: Total Missing objects: 0
• DQMHistoSizes: Histogram memory added: 0.0 KiB( 41 files compared)
• Checked 177 log files, 37 edm output root files, 42 DQM output files
• TriggerResults: no differences found

[agrohsje]

@qliphy @perrotta should we apply the cms coding rules to the code that is based on external input? please let us know.

[perrotta]

@qliphy @perrotta should we apply the cms coding rules to the code that is based on external input? please let us know.

Well, for the part that sits on CMSSW why not?
Unless you are copying code from (e.g.) pythia, and I understand that for the sake of maintainability it would be advisable to limit the changes wrt the original code to the minimum

[agrohsje]

Hi @cericeci. The code by Simon is still private and not planned to be part of P8 or whatever? If not, @perrotta suggested to adjust. Let me know.

[cericeci]

Hey @agrohsje @perrotta, my understanding is that there was no intention of having it merged with P8 (the public gitlab of the code has been around for a year or so without any discussion that I see). I got it second-hand from @kpedro88, though, maybe he is aware of an ongoing effort that I don't know about and can comment.
If that's the case (and the policy) I'll update the proper files to follow CMS' conventions

[cericeci]

@agrohsje I modified the code to make it more cmssw-compliant as recommended by @perrotta, including some more cleanup and commenting so what the showering module does is more clear. I'd like for this one to be reviewed

[agrohsje]

please test

[cmsbuild]

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-36238/27043

• This PR adds an extra 36KB to repository

• Found files with invalid states:

  • GeneratorInterface/Pythia8Interface/src/suep_shower.cc:
    • Added: 2bc08a1
    • Modified: 01dc7b3
    • Deleted: 9cfff19
  • GeneratorInterface/Pythia8Interface/interface/suep_shower.h:
    • Added: 2bc08a1
    • Modified: 01dc7b3
    • Deleted: 9cfff19

[cmsbuild]

Pull request #36238 was updated. @SiewYan, @mkirsano, @Saptaparna, @GurpreetSinghChahal, @agrohsje, @alberto-sanchez can you please check and sign again.

[cmsbuild]

+1

Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-0e55d9/20892/summary.html
COMMIT: 9cfff19
CMSSW: CMSSW_12_2_X_2021-11-30-1100/slc7_amd64_gcc900
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week1/cms-sw/cmssw/36238/20892/install.sh to create a dev area with all the needed externals and cmssw changes.

Comparison Summary

Summary:

• No significant changes to the logs found
• Reco comparison results: 0 differences found in the comparisons
• DQMHistoTests: Total files compared: 41
• DQMHistoTests: Total histograms compared: 3042214
• DQMHistoTests: Total failures: 0
• DQMHistoTests: Total nulls: 0
• DQMHistoTests: Total successes: 3042192
• DQMHistoTests: Total skipped: 22
• DQMHistoTests: Total Missing objects: 0
• DQMHistoSizes: Histogram memory added: 0.0 KiB( 40 files compared)
• Checked 175 log files, 37 edm output root files, 41 DQM output files
• TriggerResults: no differences found

[agrohsje]

+generators

[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. @perrotta, @dpiparo, @qliphy (and backports should be raised in the release meeting by the corresponding L2)

[qliphy]

+1