Herwig7ConfigLHEF.py

Go to the documentation of this file.

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

 
import os
 
from . import Herwig7Config as hw7Config
from . import Herwig7Control as hw7Control
from . import Herwig7Utils as hw7Utils
 
 

class Hw7ConfigLHEF(hw7Config.Hw7Config):
 
 
  def __init__(self, genSeq, runArgs, run_name="Herwig", beams="pp"):
 
    beams = beams.upper()
    if beams not in ["EE", "EP" , "PP"]:
      raise RuntimeError(hw7Utils.ansi_format_error("Parameter 'beams' must be one of the following: ['EE', 'EP' , 'PP']"))
 
    
    super(Hw7ConfigLHEF, self).__init__(genSeq, runArgs, run_name)
 
    self.beams = beams
 
    self.set_lhef_mg5amc_commands = False
    self.set_lhef_powhegbox_commands = False
 
 
  def local_pre_commands(self):
 
    return """
## ============================================
## Local Pre-Commands from Herwig7ConfigLHEF.py
## ============================================
 
# > no local pre-commands at the moment
"""
 
 
  def local_post_commands(self):
 
    return """
## =============================================
## Local Post-Commands from Herwig7ConfigLHEF.py
## =============================================
 
saverun {} /Herwig/Generators/EventGenerator
""".format(self.run_name)
 
 
 
  
  def run(self):
 
    
 
    self.default_commands += self.beam_commands()
    self.default_commands += self.random_seed_commands()
    
    if not self.set_printout_commands:
      self.default_commands += self.printout_commands()
    if not self.set_physics_parameter_commands:
      self.default_commands += self.physics_parameter_commands()
    if not self.set_technical_parameter_commands:
      self.default_commands += self.technical_parameter_commands()
 
    
 
    if self.set_lhef_mg5amc_commands and self.set_lhef_powhegbox_commands:
      raise RuntimeError(hw7Utils.ansi_format_error("Please do not use both 'lhef_mg5amc_commands()' and 'lhef_powhegbox_commands()' at the same time!"))
    if not self.set_lhef_mg5amc_commands and not self.set_lhef_powhegbox_commands:
      raise RuntimeError(hw7Utils.ansi_format_error("Please use either 'lhef_mg5amc_commands()' or 'lhef_powhegbox_commands()' in the JobOptions!"))
 
    
 
    hw7Control.run(self)
 
 
  
  def __lhef_commands(self, lhe_filename="events.lhe", me_pdf_order="NLO", usespin=True, usepwghlhereader=False, pwg_reader = "powheg", pwg_reader_lib="libpowhegHerwig.so"):
 
    if me_pdf_order not in ["LO", "NLO"]:
      raise RuntimeError(hw7Utils.ansi_format_error("Herwig7ConfigLHEF.py:__lhef_commands: Parameter 'me_pdf_order' must either be 'LO' or 'NLO'!"))
 
    if lhe_filename.endswith(".tar.gz"): # athena will decompress the LHE file for us
      lhe_filename = lhe_filename.replace(".tar.gz", ".events")
      if not os.path.isfile(lhe_filename):
        raise RuntimeError(hw7Utils.ansi_format_error("Herwig7ConfigLHEF.py:__lhef_commands: Could not find decompressed LHE file '{}'!".format(lhe_filename)))
 
    momentum_treatment = ""
    beam_commands = ""
    if self.beams == "EE":
      momentum_treatment = "Accept"
    elif self.beams == "EP":
      momentum_treatment = "RescaleEnergy"
      beam_commands = """
## Set the PDF for the LHE reader
# set /Herwig/EventHandlers/LHEReader:PDFA /Herwig/Partons/Hard{MEPDFOrder}PDF
""".format(MEPDFOrder = me_pdf_order)
    elif self.beams == "PP":
      momentum_treatment = "RescaleEnergy"
      beam_commands = """
## Set the PDF for the LHE reader
# set /Herwig/EventHandlers/LHEReader:PDFA /Herwig/Partons/Hard{MEPDFOrder}PDF
# set /Herwig/EventHandlers/LHEReader:PDFB /Herwig/Partons/Hard{MEPDFOrder}PDF
""".format(MEPDFOrder = me_pdf_order)
 
    pwg_reader_lib = "library "+pwg_reader_lib
 
    self.commands += """
## ----------------------------
## Read in Events from LHE File
## ----------------------------
 
## Create the Handler and Reader
library LesHouches.so
create ThePEG::LesHouchesEventHandler /Herwig/EventHandlers/LHEHandler
{PwgReaderLib}
create ThePEG::{PwgReader}LesHouchesFileReader /Herwig/EventHandlers/LHEReader
 
## Set LHE filename
set /Herwig/EventHandlers/LHEReader:FileName {FileName}
 
## Setup LHE event handler and LHE reader
set /Herwig/Generators/EventGenerator:EventHandler /Herwig/EventHandlers/LHEHandler
insert /Herwig/EventHandlers/LHEHandler:LesHouchesReaders 0 /Herwig/EventHandlers/LHEReader
set /Herwig/EventHandlers/LHEHandler:PartonExtractor /Herwig/Partons/{Beams}Extractor
set /Herwig/EventHandlers/LHEHandler:CascadeHandler /Herwig/Shower/ShowerHandler
set /Herwig/EventHandlers/LHEHandler:HadronizationHandler /Herwig/Hadronization/ClusterHadHandler
set /Herwig/EventHandlers/LHEHandler:DecayHandler /Herwig/Decays/DecayHandler
set /Herwig/EventHandlers/LHEHandler:WeightNormalization CrossSection
set /Herwig/EventHandlers/LHEHandler:WeightOption VarNegWeight
set /Herwig/EventHandlers/LHEReader:IncludeSpin {IncludeSpin}
set /Herwig/EventHandlers/LHEReader:MomentumTreatment {MomentumTreatment}
set /Herwig/EventHandlers/LHEReader:AllowedToReOpen No
 
## Parton shower settings
set /Herwig/Shower/ShowerHandler:MaxPtIsMuF Yes
set /Herwig/Shower/ShowerHandler:RestrictPhasespace Yes
# treatment of wide angle radiation
set /Herwig/Shower/PartnerFinder:PartnerMethod Random
set /Herwig/Shower/PartnerFinder:ScaleChoice Partner
 
## Don't use any cuts on LHE files
create ThePEG::Cuts /Herwig/Cuts/NoCuts
set /Herwig/EventHandlers/LHEReader:Cuts /Herwig/Cuts/NoCuts
 
{BeamCommands}
""".format(FileName = lhe_filename,
           PwgReaderLib = pwg_reader_lib if usepwghlhereader else "",
           PwgReader = pwg_reader if usepwghlhereader else "",
           Beams = self.beams,
           IncludeSpin = "Yes" if usespin else "No",
           MomentumTreatment = momentum_treatment,
           BeamCommands = beam_commands)
 
 
  
  def lhef_mg5amc_commands(self, lhe_filename="events.lhe", me_pdf_order="NLO", usespin=True):
 
    if me_pdf_order not in ["LO", "NLO"]:
      raise RuntimeError(hw7Utils.ansi_format_error("Herwig7ConfigLHEF.py:lhef_mg5amc_commands: Parameter 'me_pdf_order' must either be 'LO' or 'NLO'!"))
 
    self.set_lhef_mg5amc_commands = True
 
    self.__lhef_commands(lhe_filename, me_pdf_order, usespin)
 
    self.commands += """
## Commands specific to showering of events produced with MG5_aMC@NLO
set /Herwig/Shower/KinematicsReconstructor:ReconstructionOption General
set /Herwig/Shower/KinematicsReconstructor:InitialInitialBoostOption LongTransBoost
set /Herwig/Shower/KinematicsReconstructor:InitialStateReconOption Rapidity
set /Herwig/Shower/ShowerHandler:SpinCorrelations No
"""
     
    # this option is not available anymore in Herwig 7.2:
    if os.environ['HERWIG7VER'].startswith('7.1'):
      self.command += """set /Herwig/Shower/KinematicsReconstructor:FinalStateReconOption Default"""
 
  
  def lhef_powhegbox_commands(self, lhe_filename="events.lhe", me_pdf_order="NLO", usespin=True, usepwhglhereader=False, pwg_reader = "powheg", pwg_reader_lib="libpowhegHerwig.so"):
 
    if me_pdf_order not in ["LO", "NLO"]:
      raise RuntimeError(hw7Utils.ansi_format_error("Herwig7ConfigLHEF.py:lhef_powhegbox_commands: Parameter 'me_pdf_order' must either be 'LO' or 'NLO'!"))
 
    self.set_lhef_powhegbox_commands = True
 
    self.__lhef_commands(lhe_filename, me_pdf_order, usespin, usepwhglhereader, pwg_reader, pwg_reader_lib)