Herwig7Config.py

Go to the documentation of this file.

# Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
 

 
from . import Herwig7Utils as hw7Utils
 
# Helper for resetting process number
from MCJobOptionUtils.JOsupport import check_reset_proc_number
 
# import Athena modules
from AthenaCommon import Logging
athMsgLog = Logging.logging.getLogger('Herwig7Config')
 

class Hw7Config(object):
 
  
  def __init__(self, genSeq, runArgs, run_name="Herwig"):
 
    # Force Herwig7 to run in single-core mode
    check_reset_proc_number(runArgs)
 
    self.genSeq   = genSeq
    self.runArgs  = runArgs
 
    self.run_name = run_name
    # self.seed     = runArgs.randomSeed
    # self.energy   = runArgs.ecmEnergy
 
    self.me_pdf_name  = "MMHT2014lo68cl"
    self.mpi_pdf_name = "MMHT2014lo68cl"
 
    self.set_printout_commands            = False
    self.set_physics_parameter_commands   = False
    self.set_technical_parameter_commands = False
    self.use_PDGparams = False
 
    self.default_commands = hw7Utils.ConfigurationCommands()
    self.commands         = hw7Utils.ConfigurationCommands()
 
  
  def global_pre_commands(self):
    return """
## =========================================
## Global Pre-Commands from Herwig7Config.py
## =========================================
 
## ensure JetFinder uses AntiKt with R=0.4
set /Herwig/Cuts/JetFinder:Variant AntiKt
set /Herwig/Cuts/JetFinder:ConeRadius 0.4
"""
 
 
  
  def add_commands(self, commands):
 
    self.commands += commands
 
 
  
  def random_seed_commands(self):
 
    return("""
## Random number generator seed
set /Herwig/Random:Seed {}
""".format(self.runArgs.randomSeed))
 
  
  def beam_commands(self):
 
    if self.beams == "EE":
      return("""
## Commands for lepton-lepton collisions
read snippets/EECollider.in
set /Herwig/Shower/PartnerFinder:QEDPartner IIandFF
set /Herwig/Shower/ShowerHandler:MPIHandler NULL
set /Herwig/DipoleShower/DipoleShowerHandler:MPIHandler NULL
set /Herwig/Shower/PowhegShowerHandler:MPIHandler NULL
""")
    elif self.beams == "EP":
      return("""
## Commands for proton-lepton collisions
read snippets/EPCollider.in
do /Herwig/Shower/SplittingGenerator:DeleteFinalSplitting e-->e-,gamma; /Herwig/Shower/LtoLGammaSudakov
do /Herwig/Shower/SplittingGenerator:DeleteFinalSplitting mu-->mu-,gamma; /Herwig/Shower/LtoLGammaSudakov
do /Herwig/Shower/SplittingGenerator:DeleteFinalSplitting tau-->tau-,gamma; /Herwig/Shower/LtoLGammaSudakov
set /Herwig/Shower/KinematicsReconstructor:ReconstructionOption Colour
""")
    else:
      return("""
## Commands for proton-proton collisions
read snippets/PPCollider.in
""")
 
  
  def energy_commands(self):
 
    return("""
## Center-of-mass energy
set /Herwig/Generators/EventGenerator:EventHandler:LuminosityFunction:Energy {}
""".format(self.runArgs.ecmEnergy))
 
 
  
  def printout_commands(self):
 
    self.set_printout_commands = True
    
    return("""
 
## Verbosity and printout settings
set /Herwig/Generators/EventGenerator:DebugLevel 1
set /Herwig/Generators/EventGenerator:PrintEvent 2
set /Herwig/Generators/EventGenerator:UseStdout Yes
set /Herwig/Generators/EventGenerator:NumberOfEvents 1000000000
set /Herwig/Generators/EventGenerator:MaxErrors 500
 
## Make sampler print out cross sections for each subprocess
set /Herwig/Samplers/Sampler:Verbose Yes
""")
 
    
 
  def physics_parameter_commands(self):
    if self.use_PDGparams:
       paramlist = []
       self.physics_parameter_commands = True
    
       paramlist.append("## Masses and widths: PDG 2019 values")
    
    
       from EvgenProdTools.offline_dict import parameters
       for k,v in parameters.items():
         if k == 'particles':
           for key,value in v.items():
             if int(key) == 24:
               paramlist.append("set /Herwig/Particles/"+value['name']+"+:NominalMass "+value['mass'])
               paramlist.append("set /Herwig/Particles/"+value['name']+"+:Width "+value['width'])
               paramlist.append("set /Herwig/Particles/"+value['name']+"-:NominalMass "+value['mass'])
               paramlist.append("set /Herwig/Particles/"+value['name']+"-:Width "+value['width'])
             if int(key) == 23:
               paramlist.append("set /Herwig/Particles/"+value['name']+"0:NominalMass "+value['mass'])
               paramlist.append("set /Herwig/Particles/"+value['name']+"0:Width "+value['width'])
             if int(key) == 6:
               paramlist.append("set /Herwig/Particles/"+value['name']+"bar:NominalMass "+value['mass'])
               paramlist.append("set /Herwig/Particles/"+value['name']+"bar:Width "+value['width'])         
               paramlist.append("set /Herwig/Particles/"+value['name']+":NominalMass "+value['mass'])
               paramlist.append("set /Herwig/Particles/"+value['name']+":Width "+value['width'])
   
    
         if k == 'EW_parameters':
           for key,value in v.items():
             if key[2] == "Sin2ThetaW":
               paramlist.append("set /Herwig/Model:EW/"+str(key[2])+" "+str(value))
       paramstring = '\n'.join(paramlist)
       return(paramstring)
 
    else:
       self.physics_parameter_commands = True
 
       return("""
## Masses and widths: PDG 2010 values (except TOP mass; kept at PDG2007)
 
## top-quark
set /Herwig/Particles/t:NominalMass 172.5*GeV
set /Herwig/Particles/tbar:NominalMass 172.5*GeV
## W boson
set /Herwig/Particles/W+:NominalMass 80.399*GeV
set /Herwig/Particles/W-:NominalMass 80.399*GeV
set /Herwig/Particles/W+:Width 2.085*GeV
set /Herwig/Particles/W-:Width 2.085*GeV
## Z boson
set /Herwig/Particles/Z0:NominalMass 91.1876*GeV
set /Herwig/Particles/Z0:Width 2.4952*GeV
## b quark
set /Herwig/Particles/b:NominalMass 4.95*GeV
set /Herwig/Particles/bbar:NominalMass 4.95*GeV
 
## Weinberg angle
set /Herwig/Model:EW/Sin2ThetaW 0.23113
""")
 
  def technical_parameter_commands(self):
 
    self.set_technical_parameter_commands = True
 
    return("""
## Disable default attempts to use Pomeron PDF data files, until we're worked how to do that on the Grid!
set /Herwig/Particles/pomeron:PDF /Herwig/Partons/NoPDF
 
## Set long-lived particles stable
set /Herwig/Decays/DecayHandler:MaxLifeTime 10*mm
""")
 
 
 
  
  def me_alphas_commands(self, order="NLO", scale=91.1876, value=0.118):
 
    if order not in ["LO", "NLO"]:
      raise RuntimeError(hw7Utils.ansi_format_error("Parameter 'order' must either be 'LO' or 'NLO'!"))
 
    self.commands += """
## Configure {0} AlphaS for the hard process
## (LO: 1-loop-running / NLO: 2-loop running)
set /Herwig/Couplings/{0}AlphaS:input_scale {1}
set /Herwig/Couplings/{0}AlphaS:input_alpha_s {2}
set /Herwig/Model:QCD/RunningAlphaS /Herwig/Couplings/{0}AlphaS
""".format(order, scale, value)
 
 
  
  def me_pdf_commands(self, order="NLO", name="MMHT2014nlo68cl", member=0, max_flav=5):
 
    if order not in ["LO", "NLO"]:
      raise RuntimeError(hw7Utils.ansi_format_error("Parameter 'order' must either be 'LO' or 'NLO'!"))
 
    self.me_pdf_name = name
 
    self.commands += """
## Configure {0} PDF set for the hard process
set /Herwig/Partons/Hard{0}PDF:PDFName {1}
set /Herwig/Partons/Hard{0}PDF:Member {2}
set /Herwig/Partons/Hard{0}PDF:MaxFlav {3}
set /Herwig/Partons/Hard{0}PDF:RemnantHandler /Herwig/Partons/HadronRemnants
set /Herwig/Particles/p+:PDF /Herwig/Partons/Hard{0}PDF
set /Herwig/Particles/pbar-:PDF /Herwig/Partons/Hard{0}PDF
set /Herwig/Partons/PPExtractor:FirstPDF  /Herwig/Partons/Hard{0}PDF
set /Herwig/Partons/PPExtractor:SecondPDF /Herwig/Partons/Hard{0}PDF
""".format(order, name, member, max_flav)
 
 
  
  def shower_pdf_commands(self, order="LO", name="MMHT2014lo68cl", member=0, max_flav=5):
 
    if order not in ["LO", "NLO"]:
      raise RuntimeError(hw7Utils.ansi_format_error("Parameter 'order' must either be 'LO' or 'NLO'!"))
 
    
 
    self.commands += """
## Configure {0} PDF set for the parton shower
set /Herwig/Partons/Shower{0}PDF:PDFName {1}
set /Herwig/Partons/Shower{0}PDF:Member {2}
set /Herwig/Partons/Shower{0}PDF:MaxFlav {3}
set /Herwig/Shower/ShowerHandler:PDFA /Herwig/Partons/Shower{0}PDF
set /Herwig/Shower/ShowerHandler:PDFB /Herwig/Partons/Shower{0}PDF
set /Herwig/Shower/PowhegShowerHandler:PDFA /Herwig/Partons/Shower{0}PDF
set /Herwig/Shower/PowhegShowerHandler:PDFB /Herwig/Partons/Shower{0}PDF
set /Herwig/DipoleShower/DipoleShowerHandler:PDFA /Herwig/Partons/Shower{0}PDF
set /Herwig/DipoleShower/DipoleShowerHandler:PDFB /Herwig/Partons/Shower{0}PDF
""".format(order, name, member, max_flav)
 
 
  
  def mpi_pdf_commands(self, name="MMHT2014lo68cl", member=0, max_flav=5):
 
    self.mpi_pdf_name = name
 
    self.commands += """
## Configure MPI PDF
set /Herwig/Partons/MPIPDF:PDFName {}
set /Herwig/Partons/MPIPDF:Member {}
set /Herwig/Partons/MPIPDF:MaxFlav {}
""".format(name, member, max_flav)
 
 
  
  def remnant_pdf_commands(self, name="MMHT2014lo68cl", member=0, max_flav=5):
 
    self.commands += """
## Configure Remnant PDF
set /Herwig/Partons/RemnantPDF:PDFName {}
set /Herwig/Partons/RemnantPDF:Member {}
set /Herwig/Partons/RemnantPDF:MaxFlav {}
""".format(name, member, max_flav)
 
 
 
  
  def tune_commands(self, ps_tune_name = "H7-PS-MMHT2014LO", ue_tune_name = "H7.2-Default"):
 
    cmds = """
## -------------
## Tune Settings
## -------------
"""
    self.commands += cmds
    # self.ps_tune_commands(tune_name = ps_tune_name) # the name of the default PS tune may be obsolete
    self.ue_tune_commands(tune_name = ue_tune_name)
 
 
  
  def ps_tune_commands(self, tune_name = "H7-PS-MMHT2014LO"):
 
    cmds = """
## Parton shower / hadronization tune settings
"""
 
    if tune_name == "H7-PS-MMHT2014LO":
      cmds += """
# > The parton shower / hadronization tune "H7-MMHT2014LO" is already
# > configured in Herwig7 via the default settings.
"""
    # elif tune_name == "some-other-name":
    #   cmds += self.load_PS_tune(tune_name)
    else:
      raise Exception("Parton shower tune name '{}' unknown".format(tune_name))
 
    self.commands += cmds
 
 
  def load_PS_tune(self, tune_name):
 
    return """
## some commands
"""
 
 
  
  def ue_tune_commands(self, tune_name = "H7.2-Default"):
 
    cmds = """
## Underlying event tune settings
"""
 
    if tune_name == "H7.2-Default":
      cmds += """
# > The underlying event tune "H7.2-Default" is already
# > configured in Herwig7 via the default settings.
"""
    # elif tune_name == "some-other-name":
    #   cmds = self.UE_tune_commands(tune_name)
    else:
      raise Exception("Underlying event tune name '{}' unknown".format(tune_name))
 
    self.commands += cmds
 
 
  def load_ue_tune(self, tune_name):
 
    return """
## some commands
"""
 
 
  def get_dpdf_path(self):
    import os
    cmt_path = os.environ.get("CMAKE_PREFIX_PATH")
    cmt_dir = os.environ.get("BINARY_TAG")
    
    cmtPaths = cmt_path.split(':')
    
    for path in cmtPaths:
      pathNow = path + "/InstallArea/" + cmt_dir + "/share/"
      try:
        fileList = os.listdir(pathNow)
      except Exception:
        fileList = []
      if "HerwigDefaults.rpo" in fileList:
        simSharePath = pathNow
 
    dpdf_path = os.path.dirname(os.path.normpath(os.path.join(simSharePath, os.readlink(simSharePath + 'HerwigDefaults.rpo')))) + "/PDF/diffraction/"
    
    return dpdf_path
 
 
  
  def pdf_pomeron_cmds(self, flux, pdf):
 
    dpdf_path = self.get_dpdf_path()
 
    cmds  = "\n"
    cmds += "set /Herwig/Partons/PomeronPDF:RootName %s\n" % dpdf_path
    cmds += "set /Herwig/Partons/PomeronFlux:PDFFit %s\n"  % flux
    cmds += "set /Herwig/Partons/PomeronPDF:PDFFit %s\n"  % pdf
 
    cmds += """\
set /Herwig/Particles/pomeron:PDF /Herwig/Partons/PomeronPDF
 
# Technical parameters for this run
set /Herwig/Generators/EventGenerator:EventHandler:Sampler:Ntry 100000
set /Herwig/Generators/EventGenerator:MaxErrors 500
 
# MPI doesn't work
# TODO: Is this a problem?
set /Herwig/Generators/EventGenerator:EventHandler:CascadeHandler:MPIHandler NULL
 
# Choice of phase-space generation for PDFs
set /Herwig/Partons/PPExtractor:FlatSHatY 0
 
"""
    return cmds
 
 
  
  def pdf_gammagamma_cmds(self):
 
    return """
 
# Technical parameters for this run
set /Herwig/Generators/EventGenerator:EventHandler:Sampler:Ntry 100000
 
# Choice of phase-space generation for PDFs
set /Herwig/Partons/PPExtractor:FlatSHatY 0
 
# Change the proton PDFs to those for photon radiation
set /Herwig/Particles/p+:PDF    /Herwig/Partons/BudnevPDF
set /Herwig/Particles/pbar-:PDF /Herwig/Partons/BudnevPDF
 
# MPI doesn't work
# TODO: Is this a problem?
set /Herwig/Generators/EventGenerator:EventHandler:CascadeHandler:MPIHandler NULL
 
"""
 
  # Set the tune schemes for the new angular ordering of the shower
  def set_tune_scheme(self, tune_scheme="DotProduct"):
    tune_schemes = ["DotProduct-Veto","DotProduct","pT","Q2"]
    if tune_scheme not in tune_schemes:
      athMsgLog.warn("Please choose one of the supported tune-schemes! (DotProduct-Veto,DotProduct,pT,Q2)")
    else:
      athMsgLog.info("{tune_scheme:s} was used for the tune scheme.".format(tune_scheme=tune_scheme))
    # create a tune-section in the config
    self.commands += """\
\n## -------------
## Tune Settings
## -------------
 
# Tune-{tune_scheme:s}
read snippets/EvolutionScheme-{tune_scheme:s}.in
read snippets/Tune-{tune_scheme:s}.in
""".format(tune_scheme=tune_scheme)
 
  # Add the commands for enabling shower scale variations
  def enable_angularShowerScaleVariations(self, do_variations=False):
    if do_variations:
      self.commands += """\
\n## -----------------------
## Shower scale variation
## -----------------------
cd /Herwig/Shower
do ShowerHandler:AddVariation MUR2_MUF2_SHOWER_HARD     2 2     Hard
do ShowerHandler:AddVariation MUR2_MUF1_SHOWER_HARD     2 1     Hard
do ShowerHandler:AddVariation MUR1_MUF2_SHOWER_HARD     1 2     Hard
do ShowerHandler:AddVariation MUR1_MUF0.5_SHOWER_HARD   1 0.5   Hard
do ShowerHandler:AddVariation MUR0.5_MUF1_SHOWER_HARD   0.5 1   Hard
do ShowerHandler:AddVariation MUR0.5_MUF0.5_SHOWER_HARD 0.5 0.5 Hard
do ShowerHandler:AddVariation MUR2_MUF2_SHOWER_SEC      2 2     Secondary
do ShowerHandler:AddVariation MUR2_MUF1_SHOWER_SEC      2 1     Secondary
do ShowerHandler:AddVariation MUR1_MUF2_SHOWER_SEC      1 2     Secondary
do ShowerHandler:AddVariation MUR1_MUF0.5_SHOWER_SEC    1 0.5   Secondary
do ShowerHandler:AddVariation MUR0.5_MUF1_SHOWER_SEC    0.5 1   Secondary
do ShowerHandler:AddVariation MUR0.5_MUF0.5_SHOWER_SEC  0.5 0.5 Secondary
set SplittingGenerator:Detuning 2.0      
"""