Herwig7ConfigMatchbox.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
 
from AthenaCommon import Logging
athMsgLog = Logging.logging.getLogger('Herwig7ConfigMatchbox')
 
 
 
class Hw7ConfigMatchbox(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(Hw7ConfigMatchbox, self).__init__(genSeq, runArgs, run_name)
 
    self.beams = beams
 
 
  def local_pre_commands(self):
 
    # try to locate the MG5_aMC@NLO installation
    try:
      MG5aMC_path = os.environ['MADPATH']
    except KeyError:
      raise RuntimeError("MADPATH environment variable not set")
    if not os.path.isfile(os.path.join(MG5aMC_path, 'bin', 'mg5_aMC')):
      athMsgLog.warn(hw7Utils.ansi_format_warning("The MadGraph5_aMC@NLO installation can't be found from $MADPATH = {}, so don't be surprised if your run crashes in you are using matrix elements from MG5_aMC@NLO in Herwig7 / Matchbox. Please ensure that the location exists, that you have permissions to access it and that it contains the executable 'bin/mg5_aMC'".format(MG5aMC_path)))
 
    # try to locate the GoSam installation
    try:
      GoSam_path = os.environ['GOSAM_PATH']
    except KeyError:
      raise RuntimeError("GOSAM_PATH environment variable not set")
    if not os.path.isfile(os.path.join(GoSam_path, 'bin', 'gosam.py')):
      athMsgLog.warn(hw7Utils.ansi_format_warning("The GoSam installation can't be found from $GOSAMPATH = {}, so don't be surprised if your run crashes in you are using matrix elements from GoSam in Herwig7 / Matchbox. Please ensure that the location exists, that you have permissions to access it and that it contains the script 'bin/gosam.py'".format(GoSam_path)))
 
    try:
      OpenLoops_path= os.environ['OPENLOOPSPATH']
    except KeyError:
      raise RuntimeError("OPENLOOPSPATH environment variable not set")
    if not os.path.isdir(os.path.join(OpenLoops_path, "proclib")):
      athMsgLog.warn(hw7Utils.ansi_format_warning("The OpenLoops process libraries can't be found from $OPENLOOPS_PATH = {}".format(OpenLoops_path)))
 
    return """
## ================================================
## Local Pre-Commands from Herwig7ConfigMatchbox.py
## ================================================
 
## Fixing interface locations for MadGraph
set /Herwig/MatrixElements/Matchbox/Amplitudes/MadGraph:BinDir {0}
set /Herwig/MatrixElements/Matchbox/Amplitudes/MadGraph:DataDir {1}
set /Herwig/MatrixElements/Matchbox/Amplitudes/MadGraph:MadgraphPrefix {2}
 
## Fixing interface locations for GoSam
set /Herwig/MatrixElements/Matchbox/Amplitudes/GoSam:BinDir {0}
set /Herwig/MatrixElements/Matchbox/Amplitudes/GoSam:DataDir {1}
set /Herwig/MatrixElements/Matchbox/Amplitudes/GoSam:GoSamPrefix {3}
 
##Fixing interface locations of Openloops
set /Herwig/MatrixElements/Matchbox/Amplitudes/OpenLoops:OpenLoopsLibs {5}
set /Herwig/MatrixElements/Matchbox/Amplitudes/OpenLoops:OpenLoopsPrefix {6}
 
read snippets/Matchbox.in
read snippets/{4}Collider.in
""".format(hw7Control.herwig7_bin_path,
           hw7Control.herwig7_share_path,
           MG5aMC_path,
           GoSam_path,
           self.beams,
           os.path.join(OpenLoops_path,"proclib"),
           OpenLoops_path)
 
 
  def local_post_commands(self):
 
    return """
## =================================================
## Local Post-Commands from Herwig7ConfigMatchbox.py
## =================================================
 
do /Herwig/MatrixElements/Matchbox/Factory:ProductionMode
saverun {} /Herwig/Generators/EventGenerator
""".format(self.run_name)
 
 
  def __configure(self):
 
    
 
    self.default_commands += self.energy_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()
 
 
  
  def run(self, integration_jobs=1, gridpack=None, cleanup_herwig_scratch=True, integrate=False):
 
    self.__configure()
 
    if gridpack:
      hw7Control.matchbox_run_gridpack(self, integration_jobs, gridpack, cleanup_herwig_scratch, integrate)
    else:
      hw7Control.matchbox_run(self, integration_jobs, cleanup_herwig_scratch)
 
 
  # atomic functions for complete control from within the JobOptions ----------
 
  
  def do_build(self, integration_jobs):
    self.__configure()
    hw7Control.do_build(self, integration_jobs)
    hw7Control.do_abort()
 
  
  def do_integrate(self, integration_job):
    hw7Control.do_integrate(self.run_name, integration_job)
    hw7Control.do_abort()
 
  
  def do_mergegrids(self, integration_jobs, gridpack=None):
    hw7Control.do_mergegrids(self.run_name, integration_jobs)
    if gridpack:
      hw7Control.do_compress_gridpack(self.run_name, gridpack)
    hw7Control.do_abort()
 
  
  def do_run(self, gridpack=None, cleanup_herwig_scratch=True):
    if gridpack:
      hw7Control.do_uncompress_gridpack(gridpack)
    hw7Control.do_run(self, cleanup_herwig_scratch)
 
 
  # configuration commands ----------------------------------------------------
 
  
  def sampler_commands(self, bin_sampler="CellGridSampler",
                       initial_points=10000, n_iterations=1, remapper_points=50000,
                       exploration_steps=4, exploration_points=500, alpha=0.8, grid_divisions=48):
 
    bin_samplers = ["CellGridSampler", "MonacoSampler", "FlatBinSampler"]
 
    if bin_sampler not in bin_samplers:
      raise RuntimeError(hw7Utils.ansi_format_error("Parameter 'bin_sampler' must be one of {}!".format(bin_samplers)))
 
    self.commands += """
##################################################
## Sampler Configuration
##################################################
set /Herwig/Samplers/Sampler:BinSampler /Herwig/Samplers/{}
set /Herwig/Samplers/Sampler:BinSampler:InitialPoints {}
set /Herwig/Samplers/Sampler:BinSampler:NIterations {}
set /Herwig/Samplers/Sampler:BinSampler:RemapperPoints {}
set /Herwig/Samplers/Sampler:BinSampler:Alpha {}
set /Herwig/Samplers/Sampler:BinSampler:GridDivisions {}
""".format(bin_sampler, initial_points, n_iterations, remapper_points, alpha, grid_divisions)
 
    if bin_sampler == "CellGridSampler":
      self.commands += """
set /Herwig/Samplers/CellGridSampler:ExplorationSteps {}
set /Herwig/Samplers/CellGridSampler:ExplorationPoints {}
""".format(exploration_steps, exploration_points)