ATLAS Offline Software
ggF_HH.py
Go to the documentation of this file.
1 # Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
2 import os
3 from AthenaCommon import Logging
4 from ..powheg_V2 import PowhegV2
5 
6 
7 logger = Logging.logging.getLogger("PowhegControl")
8 
9 
11  """! Default Powheg configuration for gluon-fusion Higgs boson production with quark mass and EW effects.
12 
13  Create a configurable object with all applicable Powheg options.
14 
15  @author James Robinson <james.robinson@cern.ch>
16  """
17 
18  def __init__(self, base_directory, **kwargs):
19  """! Constructor: all process options are set here.
20 
21  @param base_directory: path to PowhegBox code.
22  @param kwargs dictionary of arguments from Generate_tf.
23  """
24  super(ggF_HH, self).__init__(base_directory, "ggHH", **kwargs)
25 
26  # Add grid file creation function
27  self.validation_functions.append("create_grid_file")
28 
29  # This process uses a python script which uses .grid files searched for in $PYTHONPATH
30  # By appending the folder that they live in to PYTHONPATH it is able to find them
31  # At the moment these files are stored or linked locally, so we use ${PWD}
32  # but we may use self.executable.replace("pwhg_main", "Virtual") instead at some point
33  os.environ["PYTHONPATH"] += ":" + os.environ["PWD"]
34 
35  # need to use libraries compatible with the environment used at compilation (so centos7)
36  # would need to use ${LHAPDF_INSTAL_PATH}/lib/python3.9/site-packages when/if the process compiles in alma9 eventually
37  lhapdf_python_path = "/cvmfs/sft.cern.ch/lcg/releases/LCG_101/MCGenerators/lhapdf/6.3.0/x86_64-centos7-gcc8-opt/lib/python3.9/site-packages"
38  os.environ["PYTHONPATH"] += ":" + lhapdf_python_path
39 
40  logger.info('PYTHONPATH is now:\n{}'.format(os.environ["PYTHONPATH"]))
41 
42  # Add all keywords for this process, overriding defaults if required
43  self.add_keyword("alphas_from_lhapdf")
44  self.add_keyword("bornktmin")
45  self.add_keyword("bornonly")
46  self.add_keyword("bornsuppfact")
47  self.add_keyword("bornzerodamp")
48  self.add_keyword("bottomthr")
49  self.add_keyword("bottomthrpdf")
50  self.add_keyword("btildeborn")
51  self.add_keyword("btildecoll")
52  self.add_keyword("btildereal")
53  self.add_keyword("btildevirt")
54  self.add_keyword("btlscalect")
55  self.add_keyword("btlscalereal")
56  self.add_keyword("charmthr")
57  self.add_keyword("charmthrpdf")
58  self.add_keyword("check_bad_st2")
59  self.add_keyword("chhh", 1.0)
60  self.add_keyword("ct", 1.0)
61  self.add_keyword("ctt", 0.)
62  self.add_keyword("cggh", 0.)
63  self.add_keyword("cgghh", 0.)
64  self.add_keyword("clobberlhe")
65  self.add_keyword("colltest")
66  self.add_keyword("compress_lhe")
67  self.add_keyword("compress_upb")
68  self.add_keyword("compute_rwgt")
69  self.add_keyword("doublefsr")
70  self.add_keyword("evenmaxrat")
71  self.add_keyword("facscfact", self.default_scales[0])
72  self.add_keyword("fastbtlbound")
73  self.add_keyword("fixedgrid")
74  self.add_keyword("fixedscale", description="Set renormalisation and factorisation scales to 2*m_H")
75  self.add_keyword("flg_debug")
76  self.add_keyword("foldcsi", 2)
77  self.add_keyword("foldphi", 2)
78  self.add_keyword("foldy", 5)
79  self.add_keyword("fullrwgt")
80  self.add_keyword("gfermi")
81  self.add_keyword("hdamp")
82  self.add_keyword("hdecaymode")
83  self.add_keyword("hfact")
84  self.add_keyword("hmass", 125.)
85  self.add_keyword("icsimax", 2)
86  self.add_keyword("ih1")
87  self.add_keyword("ih2")
88  self.add_keyword("itmx1", 2)
89  self.add_keyword("itmx1rm")
90  self.add_keyword("itmx2", 4)
91  self.add_keyword("itmx2rm")
92  self.add_keyword("iupperfsr")
93  self.add_keyword("iupperisr")
94  self.add_keyword("iymax", 2)
95  self.add_keyword("lhans1", self.default_PDFs)
96  self.add_keyword("lhans2", self.default_PDFs)
97  self.add_keyword("lhapdf6maxsets")
98  self.add_keyword("lhrwgt_descr")
99  self.add_keyword("lhrwgt_group_combine")
100  self.add_keyword("lhrwgt_group_name")
101  self.add_keyword("lhrwgt_id")
102  self.add_keyword("LOevents")
103  self.add_keyword("manyseeds")
104  self.add_keyword("max_io_bufsize")
105  self.add_keyword("maxseeds")
106  self.add_keyword("minlo", frozen=True)
107  self.add_keyword("mintupbratlim")
108  self.add_keyword("mintupbxless")
109  self.add_keyword("mtdep", 3)
110  self.add_keyword("ncall1", 10000)
111  self.add_keyword("ncall1rm")
112  self.add_keyword("ncall2", 15000)
113  self.add_keyword("ncall2rm")
114  self.add_keyword("ncallfrominput")
115  self.add_keyword("noevents")
116  self.add_keyword("novirtual")
117  self.add_keyword("nubound", 20000)
118  self.add_keyword("olddij")
119  self.add_keyword("par_2gsupp")
120  self.add_keyword("par_diexp")
121  self.add_keyword("par_dijexp")
122  self.add_keyword("parallelstage")
123  self.add_keyword("pdfreweight")
124  self.add_keyword("ptHHcut_CT")
125  self.add_keyword("ptHHcut")
126  self.add_keyword("ptsqmin")
127  self.add_keyword("ptsupp")
128  self.add_keyword("radregion")
129  self.add_keyword("rand1")
130  self.add_keyword("rand2")
131  self.add_keyword("renscfact", self.default_scales[1])
132  self.add_keyword("rescue_reals")
133  self.add_keyword("rwl_add")
134  self.add_keyword("rwl_file")
135  self.add_keyword("rwl_format_rwgt")
136  self.add_keyword("rwl_group_events")
137  self.add_keyword("skipextratests")
138  self.add_keyword("smartsig")
139  self.add_keyword("softtest")
140  self.add_keyword("stage2init")
141  self.add_keyword("storeinfo_rwgt")
142  self.add_keyword("storemintupb")
143  self.add_keyword("testplots")
144  self.add_keyword("testsuda")
145  self.add_keyword("topmass", 173.) # this value is hardcoded in the virtual matrix element, and for consistency has not to be changed when running full theory prediction (i.e. mtdep=3)
146  self.add_keyword("ubexcess_correct")
147  self.add_keyword("ubsigmadetails")
148  self.add_keyword("use-old-grid")
149  self.add_keyword("use-old-ubound")
150  self.add_keyword("withdamp")
151  self.add_keyword("withnegweights")
152  self.add_keyword("withsubtr")
153  self.add_keyword("Wmass")
154  self.add_keyword("Wwidth")
155  self.add_keyword("xgriditeration")
156  self.add_keyword("xupbound")
157  self.add_keyword("zerowidth")
158  self.add_keyword("Zmass")
159  self.add_keyword("Zwidth")
160 
161  def create_grid_file(self):
162  """! Creates the .grid file needed by this process."""
163  """! This function calls a python script provided by the authors, which is linked to the local directory."""
164  """! The code of this function is adapted from the script ${POWHEGPATH}/POWHEG-BOX-V2/ggHH/testrun/run.sh"""
165  self.expose() # convenience call to simplify syntax
166 
167  logger.info('Now attempting to link locally the files needed by this Powheg process')
168  try:
169  os.system("ln -s " + os.environ["POWHEGPATH"] + "/POWHEG-BOX-V2/ggHH/Virtual/events.cdf events.cdf")
170  os.system("ln -s " + os.environ["POWHEGPATH"] + "/POWHEG-BOX-V2/ggHH/Virtual/creategrid.py creategrid.py")
171  os.system("for grid in " + os.environ["POWHEGPATH"] + "/POWHEG-BOX-V2/ggHH/Virtual/Virt_full_*E*.grid; do ln -s $grid ${grid##*/}; done")
172  except RuntimeError:
173  logger.error('Impossible to link the needed files locally')
174  raise
175 
176  # need to override lhapdf python path while the powheg process has been compiled in a different platform
177  py_path_save = os.environ["PYTHONPATH"]
178  py_path_temp = os.environ["LHAPDF_INSTAL_PATH"] + "/lib/python3.9/site-packages" + ":" + py_path_save
179  os.environ["PYTHONPATH"] = py_path_temp
180  logger.debug(f'Temporarily setting PYTHONPATH to:\n{py_path_temp}')
181 
182  # handling the parameters of this process
183  # these parameters need to be parsed in a specific format
184  chhh_str = f'{list(self.parameters_by_keyword("chhh"))[0].value:+.4E}'
185  ct_str = f'{list(self.parameters_by_keyword("ct"))[0].value:+.4E}'
186  ctt_str = f'{list(self.parameters_by_keyword("ctt"))[0].value:+.4E}'
187  cggh_str = f'{list(self.parameters_by_keyword("cggh"))[0].value:+.4E}'
188  cgghh_str = f'{list(self.parameters_by_keyword("cgghh"))[0].value:+.4E}'
189  grid_file_name = f'Virt_full_{chhh_str}_{ct_str}_{ctt_str}_{cggh_str}_{cgghh_str}.grid'
190 
191  logger.info('Now trying to use creategrid.py to create the Virt_full_*.grid file')
192  logger.info(f'File name: {grid_file_name}')
193  logger.info(f'Parameters are: chhh={chhh_str}, ct={ct_str}, ctt={ctt_str}, cggh={cggh_str}, cgghh={cgghh_str}')
194  try:
195  #import creategrid as cg
196  #cg.combinegrids(grid_file_name, chhh_str, ct_str, ctt_str, cggh_str, cgghh_str)
197  pythoncmd=f"import creategrid as cg; cg.combinegrids('{grid_file_name}', {chhh_str}, {ct_str}, {ctt_str}, {cggh_str}, {cgghh_str})"
198  os.system("python3 -c \""+pythoncmd+"\"")
199  except RuntimeError:
200  logger.error('Impossible to use creategrid.py to create the Virt_full_*.grid file')
201  raise
202 
203  # setting PYTHONPATH back to its original value
204  os.environ["PYTHONPATH"] = py_path_save
205  logger.debug(f'Setting PYTHONPATH back to:\n{py_path_save}')
206 
207  logger.info('Although the produced Virt_full_*.grid file now exists in the local directory, Powheg will later try to find it in all directories contained in $PYTHONPATH. This will produce several "not found" info messages which can safely be ignored.')
python.processes.configurable.Configurable.expose
def expose(self)
Add all names to the interface of this object.
Definition: configurable.py:46
python.processes.powheg.ggF_HH.ggF_HH
Default Powheg configuration for gluon-fusion Higgs boson production with quark mass and EW effects.
Definition: ggF_HH.py:10
python.processes.powheg.ggF_HH.ggF_HH.create_grid_file
def create_grid_file(self)
Creates the .grid file needed by this process.
Definition: ggF_HH.py:161
vtune_athena.format
format
Definition: vtune_athena.py:14
python.processes.powheg_base.PowhegBase.default_scales
def default_scales(self)
Default scale variations for this process.
Definition: powheg_base.py:243
python.processes.configurable.Configurable.add_keyword
def add_keyword(self, keyword, value=None, name=None, frozen=None, hidden=None, description=None, **kwargs)
Register configurable parameter that is exposed to the user.
Definition: configurable.py:21
dumpHVPathFromNtuple.append
bool append
Definition: dumpHVPathFromNtuple.py:91
python.processes.powheg_base.PowhegBase.validation_functions
validation_functions
List of validation functions to run before preparing runcard.
Definition: powheg_base.py:176
python.processes.powheg_base.PowhegBase.default_PDFs
def default_PDFs(self)
Default PDFs for this process.
Definition: powheg_base.py:238
python.processes.powheg_V2.PowhegV2
Base class for PowhegBox V2 processes.
Definition: powheg_V2.py:6
python.processes.powheg.ggF_HH.ggF_HH.__init__
def __init__(self, base_directory, **kwargs)
Constructor: all process options are set here.
Definition: ggF_HH.py:18