Base class for PowhegBox processes. More...

Inheritance diagram for python.processes.powheg_base.PowhegBase:

Collaboration diagram for python.processes.powheg_base.PowhegBase:

Public Member Functions
def	hoppet_info (self)

def	hoppet_warning (self)

def	openloops_error (self)

def	manually_set_openloops_paths (self)

def	manually_set_openloops_gnu_paths (self)

def	link_madloop_libraries (self)

def	link_external_powheg_libraries (self, librarypath)

def	__init__ (self, base_directory, version, executable_name, cores, powheg_executable="pwhg_main", is_reweightable=True, warning_output=[], info_output=[], error_output=[], **kwargs)
	Constructor. More...

def	add_algorithm (self, alg_or_process)
	Add an algorithm or external process to the sequence. More...

def	files_for_cleanup (self)
	Wildcarded list of files created by this process that can be deleted. More...

def	integration_file_names (self)
	Wildcarded list of integration files that might be created by this process. More...

def	mandatory_integration_file_names (self)
	Wildcarded list of integration files that are needed for this process. More...

def	powheg_version (self)
	Version of PowhegBox process. More...

def	default_PDFs (self)
	Default PDFs for this process. More...

def	default_scales (self)
	Default scale variations for this process. More...

def	prepare_to_parallelise (self, n_cores)
	Scale calculation parameters by n_cores. More...

def	stage_is_completed (self, stage)
	Set whether the specified POWHEG-BOX generation stage is complete. More...

def	validate_parameters (self)
	Validate any parameters which need it before preparing runcard. More...

def	validate_integration_parameters (self)
	Validate integration keywords by forcing to integer values. More...

def	check_decay_mode (self, decay_mode, allowed_decay_modes=None)
	Check whether a decay mode is allowed an raise an exception if it is not. More...

def	check_using_integration_files (self)

def	modify_parameter (self, stage=0)

def	set_parameter_in_config (self, key, value)

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. More...

def	expose (self)
	Add all names to the interface of this object. More...

def	has_keyword (self, keyword)

def	has_parameter (self, parameter)

def	parameters_by_keyword (self, keyword)
	Retrieve all parameters that use a given keyword. More...

def	parameters_by_name (self, name)
	Retrieve all parameters that use a given name. More...

Public Attributes
	executable
	Powheg executable that will be used. More...

	process_revision
	SVN revision of process code. More...

	powhegbox_revision
	Log the PowhegBox version and process-code revision for AMI etc. More...

	cores
	Number of cores to use. More...

	algorithms
	List of additional algorithms to schedule. More...

	externals
	List of external processes to schedule. More...

	validation_functions
	List of validation functions to run before preparing runcard. More...

	is_reweightable
	Switch to determine whether reweighting is allowed. More...

	use_XML_reweighting
	Switch to determine whether XML reweighting should be used. More...

	remove_oldStyle_rwt_comments
	Switch to determine if the #rwgt and #pdf comments should be kept in lhe files despite using xml reweighting. More...

	warning_output
	Special treatment for some log messages. More...

	info_output

	error_output

	parameterStageDict
	Dictionary used to change parameters of the Powheg input. More...

	parameters
	List of available parameters. More...

Detailed Description

Base class for PowhegBox processes.

All process types inherit from this class.

Author: James Robinson james.nosp@m..rob.nosp@m.inson.nosp@m.@cer.nosp@m.n.ch; Stefan Richter stefa.nosp@m.n.ri.nosp@m.chter.nosp@m.@cer.nosp@m.n.ch

Definition at line 14 of file powheg_base.py.

Constructor & Destructor Documentation

◆ init()

def python.processes.powheg_base.PowhegBase.__init__	(		self,
			base_directory,
			version,
			executable_name,
			cores,
			powheg_executable = `"pwhg_main"`,
			is_reweightable = `True`,
			warning_output = `[]`,
			info_output = `[]`,
			error_output = `[]`,
		**	kwargs
	)

Constructor.

Parameters

base_directory	path to PowhegBox code.
version	PowhegBox version.
executable_name	folder containing appropriate PowhegBox executable.
powheg_executable	name of the powheg executable.
warning_output	list of patterns which if found in the output will be treated as warning in the log.
error_output	list of patterns which if found in the output will be treated as error in the log.
info_output	list of patterns which if found in the output will be treated as info in the log.

Definition at line 138 of file powheg_base.py.

     def __init__(self, base_directory, version, executable_name, cores, powheg_executable="pwhg_main", is_reweightable=True, warning_output = [], info_output = [], error_output = [], **kwargs):
         """! Constructor.
  
         @param base_directory  path to PowhegBox code.
         @param version         PowhegBox version.
         @param executable_name folder containing appropriate PowhegBox executable.
         @param powheg_executable name of the powheg executable.
         @param warning_output list of patterns which if found in the output will be treated as warning in the log.
         @param error_output list of patterns which if found in the output will be treated as error in the log.
         @param info_output list of patterns which if found in the output will be treated as info in the log.
         """
         super(PowhegBase, self).__init__()
  
         self.executable = os.path.join(base_directory, version, executable_name, powheg_executable)
  
         self.process_revision = check_svn_revision(os.path.dirname(self.executable))
  
         one_character_version = self.powheg_version.replace('V', '')[0]
         POWHEGVER = '{v}_r{rev}'.format(v=one_character_version, rev=self.process_revision)
         logger.info('MetaData: POWHEGVER = {0}'.format(POWHEGVER))
         os.environ["POWHEGVER"] = POWHEGVER # does not export to parent shell, but might be sufficient inside job?
  
         self.powhegbox_revision = check_svn_revision(os.path.dirname(os.path.dirname(self.executable)))
  
         self.cores = cores
  
         self.algorithms = []
  
         self.externals = {}
  
         self.validation_functions = []
  
         # Universal keywords that are set from the run arguments
         self.add_keyword("ebeam1", kwargs.get("beam_energy", None))
         self.add_keyword("ebeam2", kwargs.get("beam_energy", None))
         self.add_keyword("iseed", int(kwargs.get("random_seed", None)))
         self.add_keyword("numevts", kwargs.get("nEvents", None))
  
         # Add parameter validation functions
         self.validation_functions.append("validate_integration_parameters")
  
         self.is_reweightable = is_reweightable
  
         self.use_XML_reweighting = None
  
         self.remove_oldStyle_rwt_comments = None
  
         self.warning_output = warning_output
         self.info_output = info_output
         self.error_output = error_output
  
         self.parameterStageDict = {}

Member Function Documentation

◆ add_algorithm()

def python.processes.powheg_base.PowhegBase.add_algorithm	(	self,
		alg_or_process
	)

Add an algorithm or external process to the sequence.

Parameters

process Algorithm or external process to add.

Definition at line 206 of file powheg_base.py.

     def add_algorithm(self, alg_or_process):
         """! Add an algorithm or external process to the sequence.
  
         @param process  Algorithm or external process to add.
         """
         # Either add to the list of algorithms to schedule
         if isinstance(alg_or_process, str):
             self.algorithms.append(alg_or_process)
         # ... or add as an external process
         else:
             self.externals[alg_or_process.name] = alg_or_process
  

◆ add_keyword()

def python.processes.configurable.Configurable.add_keyword	(		self,
			keyword,
			value = `None`,
			name = `None`,
			frozen = `None`,
			hidden = `None`,
			description = `None`,
		**	kwargs
	)

inherited

Register configurable parameter that is exposed to the user.

Parameters

keyword	Powheg keyword that gets written to the runcard.
value	Value of the parameter.
name	Configurable parameter name exposed to the user.
hidden	True if this parameter should be hidden from the user.
frozen	True if this parameter cannot be changed.
description	Description for the run card.
parameter	Name used in the run card if different.

Definition at line 21 of file configurable.py.

     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.
  
         @param keyword     Powheg keyword that gets written to the runcard.
         @param value       Value of the parameter.
         @param name        Configurable parameter name exposed to the user.
         @param hidden       True if this parameter should be hidden from the user.
         @param frozen       True if this parameter cannot be changed.
         @param description Description for the run card.
         @param parameter   Name used in the run card if different.
         """
         # Retrieve default settings from registry overriding if requested
         defaults = Registry().get_defaults(keyword)
         if value == defaults["value"] and value is not None and (hidden is not True):
             if keyword not in ["ebeam1", "ebeam2"]:
               logger.debug("Unnecessarily setting parameter {} to {} which is its default value!".format(keyword, value))
         value = [value, defaults["value"]][value is None]
         name = [name, defaults["name"]][name is None]
         description = [description, defaults["description"]][description is None]
         hidden = [hidden, defaults["hidden"]][hidden is None]
         frozen = [frozen, defaults["frozen"]][frozen is None]
         if keyword in [p.keyword for p in self.parameters]:
             raise AttributeError("Keyword '{}' has already been defined for this process".format(keyword))
         self.parameters.append(Parameter(keyword, name=name, value=value, frozen=frozen, hidden=hidden, description=description, **kwargs))
  

◆ check_decay_mode()

def python.processes.powheg_base.PowhegBase.check_decay_mode	(	self,
		decay_mode,
		allowed_decay_modes = `None`
	)

Check whether a decay mode is allowed an raise an exception if it is not.

Definition at line 281 of file powheg_base.py.

     def check_decay_mode(self, decay_mode, allowed_decay_modes=None):
         """! Check whether a decay mode is allowed an raise an exception if it is not."""
         if allowed_decay_modes is None:
             allowed_decay_modes = self.allowed_decay_modes
         if decay_mode not in allowed_decay_modes:
             logger.warning("Decay mode {} not recognised!".format(decay_mode))
             logger.info("Allowed decay modes are:")
             for allowed_decay_mode in allowed_decay_modes:
                 logger.info("... {}".format(allowed_decay_mode))
             raise ValueError("Decay mode {} not recognised!".format(decay_mode))
  

◆ check_using_integration_files()

def python.processes.powheg_base.PowhegBase.check_using_integration_files ( self )

Definition at line 292 of file powheg_base.py.

     def check_using_integration_files(self):
         
         search_strings = [] # list of filename patters to be searched for
         found_files = [] # list of found files will be printed out for info
         missing_patterns = [] # list of filename patters which hasn't been found but would be needed for pre-made integration grids
         try:
             search_strings = self.mandatory_integration_file_names
         except AttributeError:
             logger.fatal("No integration grid file name patterns defined for this process.")
             raise
         for s in search_strings:
             found = glob.glob(s)
             if found != []:
                 found_files += found
             else:
                 missing_patterns.append(s)
         if missing_patterns == []:
             logger.info("Integration grid files found locally. Event generation shall continue, skipping the integration step.")
             logger.info("Integration grid files found locally: {}".format(found_files))
         else:
             logger.info("Integration grid files needed were not found locally. Event generation shall continue, starting by the integration step.")
             logger.info("Missing integration grid files with these patterns: {}".format(missing_patterns))
             logger.info("Integration grid files found locally (if any): {}".format(found_files))
  
  

◆ default_PDFs()

def python.processes.powheg_base.PowhegBase.default_PDFs ( self )

Default PDFs for this process.

Reimplemented in python.processes.powheg_RES.PowhegRES, python.processes.powheg_V2.PowhegV2, and python.processes.powheg_V1.PowhegV1.

Definition at line 239 of file powheg_base.py.

     def default_PDFs(self):
         """! Default PDFs for this process."""
         raise AttributeError("Default PDFs are not known for this process!")
  

◆ default_scales()

def python.processes.powheg_base.PowhegBase.default_scales ( self )

Default scale variations for this process.

Reimplemented in python.processes.powheg_RES.PowhegRES, python.processes.powheg_V2.PowhegV2, and python.processes.powheg_V1.PowhegV1.

Definition at line 244 of file powheg_base.py.

     def default_scales(self):
         """! Default scale variations for this process."""
         raise AttributeError("Default scales are not known for this process!")
  

◆ expose()

def python.processes.configurable.Configurable.expose ( self )

inherited

Add all names to the interface of this object.

Definition at line 46 of file configurable.py.

     def expose(self):
         """! Add all names to the interface of this object."""
         for parameter in self.parameters:
             setattr(self, parameter.name, parameter.value)
  

◆ files_for_cleanup()

def python.processes.powheg_base.PowhegBase.files_for_cleanup ( self )

Wildcarded list of files created by this process that can be deleted.

Reimplemented in python.processes.powheg_RES.PowhegRES, python.processes.powheg_V2.PowhegV2, and python.processes.powheg_V1.PowhegV1.

Definition at line 219 of file powheg_base.py.

     def files_for_cleanup(self):
         """! Wildcarded list of files created by this process that can be deleted."""
         raise AttributeError("Names of unneeded files are not known for this process!")
  

◆ has_keyword()

def python.processes.configurable.Configurable.has_keyword	(	self,
		keyword
	)

inherited

Definition at line 51 of file configurable.py.

     def has_keyword(self, keyword):
         return (len(list(self.parameters_by_keyword(keyword))) > 0)
  

◆ has_parameter()

def python.processes.configurable.Configurable.has_parameter	(	self,
		parameter
	)

inherited

Definition at line 54 of file configurable.py.

     def has_parameter(self, parameter):
         return (len(list(self.parameters_by_name(parameter))) > 0)
  

◆ hoppet_info()

def python.processes.powheg_base.PowhegBase.hoppet_info ( self )

Returns a list of strings to be treated as info messages in the log
They otherwise throw an error with HOPPET v. 1.2.0
Cf. AGENE-2016

Definition at line 23 of file powheg_base.py.

     def hoppet_info(self):
         '''
         Returns a list of strings to be treated as info messages in the log
         They otherwise throw an error with HOPPET v. 1.2.0
         Cf. AGENE-2016
         '''
         return ["-----------------------------------------------------------",
                 "Welcome to HOPPET v. 1.2.0",
                 "Higher Order Perturbative Parton Evolution Toolkit",
                 "Written by Gavin P. Salam (2001-2012)",
                 "with contributions from Juan Rojo",
                 "Frederic Dreyer and Alexander Karlberg",
                 "It is made available under the GNU public license,",
                 "with the additional request that if you use it or any",
                 "derivative of it in scientific work then you should cite:",
                 "G.P. Salam & J. Rojo, CPC 180(2009)120 (arXiv:0804.3755).",
                 "You are also encouraged to cite the original references,",
                 "for LO, NLO and NNLO splitting functions, the QCD",
                 "1, 2 and 3 loop beta functions and the coupling and",
                 "PDF and coupling mass threshold matching functions."]
  

◆ hoppet_warning()

def python.processes.powheg_base.PowhegBase.hoppet_warning ( self )

Returns a list of strings to be treated as warning messages in the log
They otherwise throw an error

Definition at line 44 of file powheg_base.py.

     def hoppet_warning(self):
         '''
         Returns a list of strings to be treated as warning messages in the log
         They otherwise throw an error
         '''
         return ["WARNING in InitMTMNNLO: using parametrisation  (less accuracte) for A2PShg"]
  

◆ integration_file_names()

def python.processes.powheg_base.PowhegBase.integration_file_names ( self )

Wildcarded list of integration files that might be created by this process.

Reimplemented in python.processes.powheg_RES.PowhegRES, python.processes.powheg_V2.PowhegV2, and python.processes.powheg_V1.PowhegV1.

Definition at line 224 of file powheg_base.py.

     def integration_file_names(self):
         """! Wildcarded list of integration files that might be created by this process."""
         raise AttributeError("Integration file names are not known for this process!")
  

◆ link_external_powheg_libraries()

def python.processes.powheg_base.PowhegBase.link_external_powheg_libraries	(	self,
		librarypath
	)

Manual fix for external libraries path.
This library is expected to be installed in the POWHEGPATH folder.
Needs to be adjusted if the version of the library changes.

Definition at line 123 of file powheg_base.py.

     def link_external_powheg_libraries(self, librarypath):
         '''
         Manual fix for external libraries path.
         This library is expected to be installed in the POWHEGPATH folder.
         Needs to be adjusted if the version of the library changes.
         '''
         logger.warning("Applying manual fixes for library paths:" + librarypath)
         logger.debug("LD_LIBRARY_PATH (before) = {0}".format(os.getenv('LD_LIBRARY_PATH')))
         ldpath = os.getenv('LD_LIBRARY_PATH')
         powhegpath = os.getenv('POWHEGPATH')
         librarypath = glob.glob(powhegpath+librarypath)
         ldpath_new = ldpath+ ":" + librarypath[0]
         os.environ['LD_LIBRARY_PATH'] = ldpath_new
         logger.debug("LD_LIBRARY_PATH (after) = {0}".format(os.getenv('LD_LIBRARY_PATH')))
  

◆ link_madloop_libraries()

def python.processes.powheg_base.PowhegBase.link_madloop_libraries ( self )

Manual fix for MadLoop libraries, avoiding issues when /afs not available
This is NOT a viable long-term solution and should be made obsolete after the migration
The trick consists in making a symbolic link of some directory in the installation
which contains some files needed by MadLoop

Definition at line 95 of file powheg_base.py.

     def link_madloop_libraries(self):
         '''
         Manual fix for MadLoop libraries, avoiding issues when /afs not available
         This is NOT a viable long-term solution and should be made obsolete after the migration
         The trick consists in making a symbolic link of some directory in the installation
         which contains some files needed by MadLoop
         '''
         import os
         logger.warning("Applying manual, hard-coded fixes for MadLoop library paths")
         MadLoop_virtual = os.path.dirname(self.executable)+"/virtual"
         logger.info("Trying to link directory {} locally".format(MadLoop_virtual))
         if not os.access(MadLoop_virtual,os.R_OK):
             logger.fatal("Impossible to access directory {} needed for this process which uses MadLoop".format(MadLoop_virtual))
         if os.access("virtual",os.R_OK):# checking if link already exists
             logger.info("Found \"virtual\" probably from previous run - deleting it to recreate it with correct path")
             try:
                 os.remove("virtual")
             except Exception:
                 logger.fatal("Impossible to remove \"virtual\" symbolic link - exiting...")
                 raise
         os.symlink(MadLoop_virtual, "virtual")
         link = os.readlink("virtual")
         if link != MadLoop_virtual:
             logger.fatal("Symbolic link \"virtual\" points to {0} while it should point to {1} - linking probably didn't work. Exiting...".format(link,MadLoop_virtual))
             raise
         else:
             logger.info("Local directory \"virtual\" now points to {}".format(MadLoop_virtual))
  

◆ mandatory_integration_file_names()

def python.processes.powheg_base.PowhegBase.mandatory_integration_file_names ( self )

Wildcarded list of integration files that are needed for this process.

Reimplemented in python.processes.powheg_V2.PowhegV2, python.processes.powheg_RES.PowhegRES, and python.processes.powheg_V1.PowhegV1.

Definition at line 229 of file powheg_base.py.

     def mandatory_integration_file_names(self):
         """! Wildcarded list of integration files that are needed for this process."""
         raise AttributeError("Integration file names are not known for this process!")
  

◆ manually_set_openloops_gnu_paths()

def python.processes.powheg_base.PowhegBase.manually_set_openloops_gnu_paths ( self )

Manual fix for OpenLoops libraries path, avoiding issues when /afs not available
This is NOT a viable long-term solution and should be made obsolete after the migration
away from AFS is more advanced.

Definition at line 76 of file powheg_base.py.

     def manually_set_openloops_gnu_paths(self):
         '''
         Manual fix for OpenLoops libraries path, avoiding issues when /afs not available
         This is NOT a viable long-term solution and should be made obsolete after the migration
         away from AFS is more advanced.
         '''
         import os
         logger.warning("Applying manual, hard-coded fixes for OpenLoops library paths")
         logger.info("OpenLoopsPath (before) = {0}".format(os.getenv('OpenLoopsPath')))
         logger.debug("LD_LIBRARY_PATH (before) = {0}".format(os.getenv('LD_LIBRARY_PATH')))
         OLPath = os.path.dirname(self.executable)+"/obj-gnu"
         os.environ['OpenLoopsPath'] = OLPath
         ldpath = os.getenv('LD_LIBRARY_PATH')
         ldpath_new = OLPath+ ":" + OLPath + "/proclib:" + ldpath
         os.environ['LD_LIBRARY_PATH'] = ldpath_new
         logger.info("OpenLoopsPath (after) = {0}".format(os.getenv('OpenLoopsPath')))
         logger.debug("LD_LIBRARY_PATH (after) = {0}".format(os.getenv('LD_LIBRARY_PATH')))
  
  

◆ manually_set_openloops_paths()

def python.processes.powheg_base.PowhegBase.manually_set_openloops_paths ( self )

Manual fix for OpenLoops libraries path, avoiding issues when /afs not available
This is NOT a viable long-term solution and should be made obsolete after the migration
away from AFS is more advanced.

Definition at line 58 of file powheg_base.py.

     def manually_set_openloops_paths(self):
         '''
         Manual fix for OpenLoops libraries path, avoiding issues when /afs not available
         This is NOT a viable long-term solution and should be made obsolete after the migration
         away from AFS is more advanced.
         '''
         import os
         logger.warning("Applying manual, hard-coded fixes for OpenLoops library paths")
         logger.info("OpenLoopsPath (before) = {0}".format(os.getenv('OpenLoopsPath')))
         logger.debug("LD_LIBRARY_PATH (before) = {0}".format(os.getenv('LD_LIBRARY_PATH')))
         OLPath = os.path.dirname(self.executable)+"/obj-gfortran"
         os.environ['OpenLoopsPath'] = OLPath
         ldpath = os.getenv('LD_LIBRARY_PATH')
         ldpath_new = OLPath+ ":" + OLPath + "/proclib:" + ldpath
         os.environ['LD_LIBRARY_PATH'] = ldpath_new
         logger.info("OpenLoopsPath (after) = {0}".format(os.getenv('OpenLoopsPath')))
         logger.debug("LD_LIBRARY_PATH (after) = {0}".format(os.getenv('LD_LIBRARY_PATH')))
  

◆ modify_parameter()

def python.processes.powheg_base.PowhegBase.modify_parameter	(	self,
		stage = `0`
	)

Definition at line 317 of file powheg_base.py.

     def modify_parameter(self, stage = 0):
  
         #skip modifying if dict is empty
         if not bool(self.parameterStageDict):
             return
  
         logger.info("Modifying parameters for the stages : {0}".format(self.parameterStageDict))
  
         
         for key in self.parameterStageDict:
             settingsList = self.parameterStageDict[key]
             if abs(settingsList[2] - stage) <=1e-09:
                 self.set_parameter_in_config(key,settingsList[1])
             else: 
                 self.set_parameter_in_config(key,settingsList[0])
  

◆ openloops_error()

def python.processes.powheg_base.PowhegBase.openloops_error ( self )

Returns a list of strings to be treated as error messages in the log
They otherwise do not throw an error

Definition at line 51 of file powheg_base.py.

     def openloops_error(self):
         '''
         Returns a list of strings to be treated as error messages in the log
         They otherwise do not throw an error
         '''
         return ["[POWHEG-BOX+OpenLoops] Process not found!"]
  

◆ parameters_by_keyword()

def python.processes.configurable.Configurable.parameters_by_keyword	(	self,
		keyword
	)

inherited

Retrieve all parameters that use a given keyword.

Parameters

keyword Powheg keyword that gets written to the runcard.

Definition at line 57 of file configurable.py.

     def parameters_by_keyword(self, keyword):
         """! Retrieve all parameters that use a given keyword.
  
         @param keyword  Powheg keyword that gets written to the runcard.
         """
         return [p for p in self.parameters if p.keyword == keyword]
  

◆ parameters_by_name()

def python.processes.configurable.Configurable.parameters_by_name	(	self,
		name
	)

inherited

Retrieve all parameters that use a given name.

Parameters

name	Configurable parameter name exposed to the user.

Definition at line 64 of file configurable.py.

     def parameters_by_name(self, name):
         """! Retrieve all parameters that use a given name.
  
         @param name        Configurable parameter name exposed to the user.
         """
         return [p for p in self.parameters if p.name == name]

◆ powheg_version()

def python.processes.powheg_base.PowhegBase.powheg_version ( self )

Version of PowhegBox process.

Reimplemented in python.processes.powheg_V2.PowhegV2, python.processes.powheg_RES.PowhegRES, and python.processes.powheg_V1.PowhegV1.

Definition at line 234 of file powheg_base.py.

     def powheg_version(self):
         """! Version of PowhegBox process."""
         raise AttributeError("Powheg version is not known!")
  

◆ prepare_to_parallelise()

def python.processes.powheg_base.PowhegBase.prepare_to_parallelise	(	self,
		n_cores
	)

Scale calculation parameters by n_cores.

Definition at line 248 of file powheg_base.py.

     def prepare_to_parallelise(self, n_cores):
         """! Scale calculation parameters by n_cores."""
         __nEvents_unscaled = self.parameters_by_keyword("numevts")[0].value
         for keyword in ["ncall1", "ncall1rm", "ncall2", "ncall2rm", "nubound", "numevts"]:
             for parameter in self.parameters_by_keyword(keyword):
                 if int(parameter.value) > 0:
                     parameter.value = int(math.ceil(float(parameter.value) / n_cores))
         __nEvents_scaled = self.parameters_by_keyword("numevts")[0].value
         logger.info("Scaling number of events per job from {} down to {}".format(__nEvents_unscaled, __nEvents_scaled))
         # Freeze parallelstage parameters before printing list for user
         [parameter.freeze() for parameter in self.parameters_by_name("parallelstage")]
  

◆ set_parameter_in_config()

def python.processes.powheg_base.PowhegBase.set_parameter_in_config	(	self,
		key,
		value
	)

Definition at line 333 of file powheg_base.py.

333 def set_parameter_in_config(self, key, value):

334 FileParser("powheg.input").text_replace(key+".*", key+" {}".format(value))

◆ stage_is_completed()

def python.processes.powheg_base.PowhegBase.stage_is_completed	(	self,
		stage
	)

Set whether the specified POWHEG-BOX generation stage is complete.

Reimplemented in python.processes.powheg_V2.PowhegV2, and python.processes.powheg_RES.PowhegRES.

Definition at line 260 of file powheg_base.py.

     def stage_is_completed(self, stage):
         """! Set whether the specified POWHEG-BOX generation stage is complete."""
         # Perform manual check to allow re-use of grids in multicore mode
         return False
  

◆ validate_integration_parameters()

def python.processes.powheg_base.PowhegBase.validate_integration_parameters ( self )

Validate integration keywords by forcing to integer values.

Definition at line 270 of file powheg_base.py.

     def validate_integration_parameters(self):
         """! Validate integration keywords by forcing to integer values."""
         self.expose()  # convenience call to simplify syntax
         for name in ("foldcsi", "foldphi", "foldy", "itmx1", "itmx2", "ncall1", "ncall2", "nEvents"):
             for parameter in self.parameters_by_name(name):
                 try:
                     parameter.value = int(parameter.value)
                 except TypeError:
                     logger.fatal("Failed to validate {} with value {}".format(name, parameter.value))
                     raise
  

◆ validate_parameters()

def python.processes.powheg_base.PowhegBase.validate_parameters ( self )

Validate any parameters which need it before preparing runcard.

Definition at line 265 of file powheg_base.py.

     def validate_parameters(self):
         """! Validate any parameters which need it before preparing runcard."""
         for function_name in self.validation_functions:
             getattr(self, function_name)()
  

Member Data Documentation

◆ algorithms

python.processes.powheg_base.PowhegBase.algorithms

List of additional algorithms to schedule.

Definition at line 171 of file powheg_base.py.

◆ cores

python.processes.powheg_base.PowhegBase.cores

Number of cores to use.

Definition at line 168 of file powheg_base.py.

◆ error_output

python.processes.powheg_base.PowhegBase.error_output

Definition at line 200 of file powheg_base.py.

◆ executable

python.processes.powheg_base.PowhegBase.executable

Powheg executable that will be used.

Definition at line 152 of file powheg_base.py.

◆ externals

python.processes.powheg_base.PowhegBase.externals

List of external processes to schedule.

Definition at line 174 of file powheg_base.py.

◆ info_output

python.processes.powheg_base.PowhegBase.info_output

Definition at line 199 of file powheg_base.py.

◆ is_reweightable

python.processes.powheg_base.PowhegBase.is_reweightable

Switch to determine whether reweighting is allowed.

Definition at line 189 of file powheg_base.py.

◆ parameters

python.processes.configurable.Configurable.parameters

inherited

List of available parameters.

Definition at line 19 of file configurable.py.

◆ parameterStageDict

python.processes.powheg_base.PowhegBase.parameterStageDict

Dictionary used to change parameters of the Powheg input.

The structure is: {"parameter" : [default_value, changed_value, parallelstage_to_changed_value]}

Definition at line 204 of file powheg_base.py.

◆ powhegbox_revision

python.processes.powheg_base.PowhegBase.powhegbox_revision

Log the PowhegBox version and process-code revision for AMI etc.

Also set environment variable POWHEGVER to this contain this information SVN revision of PowhegBox code

Definition at line 165 of file powheg_base.py.

◆ process_revision

python.processes.powheg_base.PowhegBase.process_revision

SVN revision of process code.

Definition at line 155 of file powheg_base.py.

◆ remove_oldStyle_rwt_comments

python.processes.powheg_base.PowhegBase.remove_oldStyle_rwt_comments

Switch to determine if the #rwgt and #pdf comments should be kept in lhe files despite using xml reweighting.

Definition at line 195 of file powheg_base.py.

◆ use_XML_reweighting

python.processes.powheg_base.PowhegBase.use_XML_reweighting

Switch to determine whether XML reweighting should be used.

Definition at line 192 of file powheg_base.py.

◆ validation_functions

python.processes.powheg_base.PowhegBase.validation_functions

List of validation functions to run before preparing runcard.

Definition at line 177 of file powheg_base.py.

◆ warning_output

python.processes.powheg_base.PowhegBase.warning_output

Special treatment for some log messages.

Definition at line 198 of file powheg_base.py.

The documentation for this class was generated from the following file:

powheg_base.py

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ add_algorithm()

◆ add_keyword()

◆ check_decay_mode()

◆ check_using_integration_files()

◆ default_PDFs()

◆ default_scales()

◆ expose()

◆ files_for_cleanup()

◆ has_keyword()

◆ has_parameter()

◆ hoppet_info()

◆ hoppet_warning()

◆ integration_file_names()

◆ link_external_powheg_libraries()

◆ link_madloop_libraries()

◆ mandatory_integration_file_names()

◆ manually_set_openloops_gnu_paths()

◆ manually_set_openloops_paths()

◆ modify_parameter()

◆ openloops_error()

◆ parameters_by_keyword()

◆ parameters_by_name()

◆ powheg_version()

◆ prepare_to_parallelise()

◆ set_parameter_in_config()

◆ stage_is_completed()

◆ validate_integration_parameters()

◆ validate_parameters()

Member Data Documentation

◆ algorithms

◆ cores

◆ error_output

◆ executable

◆ externals

◆ info_output

◆ is_reweightable

◆ parameters

◆ parameterStageDict

◆ powhegbox_revision

◆ process_revision

◆ remove_oldStyle_rwt_comments

◆ use_XML_reweighting

◆ validation_functions

◆ warning_output

◆ init()