Base class for configurable objects in the jobOptions. More...

Inheritance diagram for python.Hto4lConfig.Hto4lConfig:

Collaboration diagram for python.Hto4lConfig.Hto4lConfig:

Public Member Functions
def	__init__ (self, runArgs=None, opts=None)

def	generate (self, filter_name='', filter_args='')
	Run normal event generation. More...

def	generateRunCard (self)
	Initialise runcard with generic options. More...

def	generateEvents (self)
	Run normal event generation. More...

def	add_parameter (self, configurable_name, value, desc='', parameter=None)
	Register configurable parameter. More...

def	add_parameter_set (self, parameter_set, **kwargs)
	Alias to DecoratorFactory.decorate. More...

def	emit_heartbeat (self, duration)
	Output a heartbeat message. More...

def	fix_parameter (self, parameter, value=None, desc='')
	Register non-configurable parameter. More...

def	runHto4l (configurator)

def	run_directory (self)
	Get run directory. More...

def	configurable_parameters (self)
	Get dictionary of configurable parameters. More...

def	fixed_parameters (self)
	Get list of non-configurable parameters. More...

def	logger (self)
	Get handle to logger. More...

def	run_card_decorators (self)
	Get list of enabled run card decorators. More...

def	run_card_path (self)
	Get full path to runcard. More...

Public Attributes
	nEvents
	Add universal functionality. More...

	random_seed

	running_process
	Initialise timer. More...

Private Attributes
	__output_events_file_name
	This needs to be set so that Generate_trf finds an appropriate file format for showering. More...

	__fixed_parameters
	Set up lists of parameters and decorators. More...

	__configurable_parameters

	__run_card_decorators

	__enable_reweighting
	Finalise registered decorators. More...

Static Private Attributes
	__run_directory = os.environ['PWD']
	Set up run directory and path to Hto4l. More...

	__logger = Logging.logging.getLogger('Hto4lControl')
	Setup athena-compatible logger. More...

string	_hto4l_executable = 'Hto4l'
	This must be defined by each derived class - don't change it in the jobOptions! _hto4l_executable = __hto4l_directory + '/Hto4l/Hto4l-v2.0/Hto4l' for local copy of Hto4l use: _hto4l_executable = __hto4l_directory + '/runGrid/Hto4l' For the lcg version of Hto4l use: _hto4l_executable = __hto4l_directory + '/Hto4l'. More...

Detailed Description

Base class for configurable objects in the jobOptions.

All subprocesses inherit from this class

Definition at line 12 of file Hto4lConfig.py.

Constructor & Destructor Documentation

◆ init()

def python.Hto4lConfig.Hto4lConfig.__init__	(	self,
		runArgs = `None`,
		opts = `None`
	)

Reimplemented in python.Hto4lPowhegDefault.Hto4lPowhegDefault.

Definition at line 35 of file Hto4lConfig.py.

   def __init__( self, runArgs=None, opts=None ) :
  
     
     self.__output_events_file_name = 'Hto4lOTF._1.events'
  
     
     self.__fixed_parameters = []
     # self.__configurable_parameters = {}
     self.__configurable_parameters = collections.OrderedDict()
     self.__run_card_decorators = []
  
     
     self.add_parameter_set( 'fromDefault' )
  
     
     if runArgs is None :
       self.logger.warning( 'No run arguments found! Using defaults.' )
     else :
       # Read values from runArgs
       if hasattr(runArgs,'maxEvents') and runArgs.maxEvents > 0 :
         self.nEvents = int( runArgs.maxEvents + 0.5 ) # should be overwritten in the jobOpt - depends on 4e/4mu/2e2mu mode
       if hasattr(runArgs,'randomSeed') :
         self.random_seed = runArgs.randomSeed
         pass
       pass
  

Member Function Documentation

◆ add_parameter()

def python.Hto4lConfig.Hto4lConfig.add_parameter	(	self,
		configurable_name,
		value,
		desc = `''`,
		parameter = `None`
	)

Register configurable parameter.

Definition at line 149 of file Hto4lConfig.py.

   def add_parameter( self, configurable_name, value, desc='', parameter=None ) :
     setattr( self, configurable_name, value ) # add new attribute
     hto4l_parameter = parameter if parameter is not None else configurable_name
     self.configurable_parameters[hto4l_parameter] = ( configurable_name, desc )
  
  

◆ add_parameter_set()

def python.Hto4lConfig.Hto4lConfig.add_parameter_set	(		self,
			parameter_set,
		**	kwargs
	)

Alias to DecoratorFactory.decorate.

Definition at line 156 of file Hto4lConfig.py.

   def add_parameter_set( self, parameter_set, **kwargs ) :
     return decorate( self, parameter_set, **kwargs )

◆ configurable_parameters()

def python.Hto4lConfig.Hto4lConfig.configurable_parameters ( self )

Get dictionary of configurable parameters.

Definition at line 210 of file Hto4lConfig.py.

   def configurable_parameters(self) :
     return self.__configurable_parameters

◆ emit_heartbeat()

def python.Hto4lConfig.Hto4lConfig.emit_heartbeat	(	self,
		duration
	)

Output a heartbeat message.

Definition at line 161 of file Hto4lConfig.py.

   def emit_heartbeat(self, duration) :
     message = 'Heartbeat: Hto4l generation has been running for {0} in total'.format( RepeatingTimer.human_readable_time_interval(duration) )
     self.logger.info( message )
     with open( '{0}/eventLoopHeartBeat.txt'.format( self.__run_directory ), 'w' ) as f : f.write( message )
  
  

◆ fix_parameter()

def python.Hto4lConfig.Hto4lConfig.fix_parameter	(	self,
		parameter,
		value = `None`,
		desc = `''`
	)

Register non-configurable parameter.

Definition at line 168 of file Hto4lConfig.py.

   def fix_parameter( self, parameter, value=None, desc='' ) :
     # Get previously set value if not overwriting
     if value is None : value = getattr( self, parameter )
     # Remove it from the configurable list if it was there
     for hto4l_parameter, configurable_name_tuple in self.configurable_parameters.items() :
       # Retrieve Hto4l parameter name and description if there is a match
       if parameter == configurable_name_tuple[0] :
         parameter, desc = hto4l_parameter, configurable_name_tuple[1]
         self.configurable_parameters.pop(hto4l_parameter)
         break
     self.fixed_parameters.append( (parameter, value, desc) )
  

◆ fixed_parameters()

def python.Hto4lConfig.Hto4lConfig.fixed_parameters ( self )

Get list of non-configurable parameters.

Definition at line 216 of file Hto4lConfig.py.

   def fixed_parameters(self) :
     return self.__fixed_parameters
  

◆ generate()

def python.Hto4lConfig.Hto4lConfig.generate	(	self,
		filter_name = `''`,
		filter_args = `''`
	)

Run normal event generation.

Definition at line 62 of file Hto4lConfig.py.

   def generate( self, filter_name='', filter_args='' ) :
     self.generateRunCard()
     self.generateEvents()
  

◆ generateEvents()

def python.Hto4lConfig.Hto4lConfig.generateEvents ( self )

Run normal event generation.

Definition at line 104 of file Hto4lConfig.py.

   def generateEvents(self) :
     
     time_start = time.time()
     self.logger.info( 'Starting Hto4l LHEF event generation at {0}'.format( time.ctime( time_start ) ) )
     self.logger.info( 'Number of events: {0}.'.format( self.nEvents ) )
  
     # Setup heartbeat thread
     heartbeat = HeartbeatTimer(600., "{}/eventLoopHeartBeat.txt".format(self.__run_directory))
     heartbeat.setName("heartbeat thread")
     heartbeat.daemon = True  # Allow program to exit if this is the only live thread
     heartbeat.start()
  
  
     
     self.running_process = []
  
     self.runHto4l()
  
     
     heartbeat.cancel()
  
     
     generation_end = time.time()
     elapsed_time = generation_end - time_start
     self.logger.info( 'Running nominal Hto4l took {0} for {1} events => {2:6.3f} Hz'.format( HeartbeatTimer.readable_duration(elapsed_time), self.nEvents, self.nEvents / elapsed_time ) )
  
     # self.logger.info( 'Removing Hto4l born LHE file' )
     # try :
     #   os.remove( 'plot_unweighted_born.lhe' )
     # except OSError :
     #   pass
  
     # ## Move output to correctly named file
     # try :
     #   os.rename( 'plot_unweighted.lhe', self.output_events_file_name )
     #   self.logger.info( 'Moved plot_unweighted.lhe to {0}'.format(self.output_events_file_name) )
     # except OSError :
     #   self.logger.warning( 'No output LHEF file found! Probably because the Hto4l process was killed before finishing.' )
  
     
     self.logger.info( 'Finished at {0}'.format( time.asctime() ) )
     return
  
  

◆ generateRunCard()

def python.Hto4lConfig.Hto4lConfig.generateRunCard ( self )

Initialise runcard with generic options.

Definition at line 67 of file Hto4lConfig.py.

   def generateRunCard(self) :
  
     
     for run_card_decorator in self.run_card_decorators :
       if hasattr( run_card_decorator, 'finalise' ) : run_card_decorator.finalise()
  
     
     self.logger.info( '** User configurable parameters for this process **' )
     self.logger.info( ': Configurable parameter :   Current value   : Description' )
     # for value_tuple in sorted( self.configurable_parameters.values(), key=lambda x: x[0].lower() ) :
     #   self.logger.info( ': {0:<22} : {1:>17} : {2}'.format( value_tuple[0], getattr(self, value_tuple[0]), value_tuple[1] ) )
     for value_tuple in self.configurable_parameters.values() :
       self.logger.info( ': {0:<22} : {1:>17} : {2}'.format( value_tuple[0], getattr(self, value_tuple[0]), value_tuple[1] ) )
  
     
     [ self.fix_parameter( parameter=value_tuple[0], desc=value_tuple[1] ) for value_tuple in self.configurable_parameters.values() ]
  
     
     self.logger.info( 'Writing Hto4l runcard to {0}'.format( self.run_card_path ) )
     with open( self.run_card_path, 'w' ) as f :
       # for parameter_tuple in sorted( self.fixed_parameters, key=lambda x: x[0].lower() ) :
       for parameter_tuple in self.fixed_parameters :
         name, value, desc = parameter_tuple
         # Set starting value to first in list when multiple values are provided
         if isinstance(value,list) :
           value = value[0]
           self.__enable_reweighting = True
         # output_line = '{0:<30}! {1}'.format( '{0}={1}'.format( name, value ), desc )
         output_line = '{0:<30}! {1}'.format( '{0}'.format( value ), desc )
         f.write( '{0}\n'.format(output_line) )
         self.logger.info( 'Wrote {0}'.format( output_line ) )
  
     
     self.logger.info( 'Using executable: {0}'.format( self._hto4l_executable ) )
  
  

◆ logger()

def python.Hto4lConfig.Hto4lConfig.logger ( self )

Get handle to logger.

Definition at line 221 of file Hto4lConfig.py.

   def logger(self) :
     return self.__logger
  

◆ run_card_decorators()

def python.Hto4lConfig.Hto4lConfig.run_card_decorators ( self )

Get list of enabled run card decorators.

Definition at line 232 of file Hto4lConfig.py.

   def run_card_decorators(self) :
     return self.__run_card_decorators

◆ run_card_path()

def python.Hto4lConfig.Hto4lConfig.run_card_path ( self )

Get full path to runcard.

Definition at line 238 of file Hto4lConfig.py.

   def run_card_path(self) :
     return '{0}/hto4l.input'.format( self.run_directory )
  

◆ run_directory()

def python.Hto4lConfig.Hto4lConfig.run_directory ( self )

Get run directory.

Definition at line 204 of file Hto4lConfig.py.

   def run_directory(self) :
     return self.__run_directory

◆ runHto4l()

def python.Hto4lConfig.Hto4lConfig.runHto4l ( configurator )

Definition at line 180 of file Hto4lConfig.py.

   def runHto4l(configurator) :
     configurator.running_process.append(subprocess.Popen( [configurator._hto4l_executable,''], stdout=subprocess.PIPE, stdin=open(configurator.run_card_path), stderr=subprocess.STDOUT ) )
  
     while configurator.running_process :
      # Write output buffer if any
      for process in configurator.running_process :
        while True :
          output = process.stdout.readline().rstrip()
          if len(output) == 0 : break
          configurator.logger.info( '{0}'.format(output) )
        if process.poll() is not None : # process has ended
          # Flush buffer and print final output (if any) to screen
          process.stdout.flush()
          while True :
            output = process.stdout.readline().rstrip()
            if len(output) == 0 : break
            configurator.logger.info( '{0}'.format(output) )
          # Close output stream and remove process from list
          process.stdout.close()
          configurator.running_process.remove( process )
          configurator.logger.info( 'Hto4l finished - all done.' )
  

Member Data Documentation

◆ __configurable_parameters

python.Hto4lConfig.Hto4lConfig.__configurable_parameters

private

Definition at line 43 of file Hto4lConfig.py.

◆ __enable_reweighting

python.Hto4lConfig.Hto4lConfig.__enable_reweighting

private

Finalise registered decorators.

Print list of configurable parameters for users Add configurable parameters to fixed list Write out final runcard

Definition at line 93 of file Hto4lConfig.py.

◆ __fixed_parameters

python.Hto4lConfig.Hto4lConfig.__fixed_parameters

private

Set up lists of parameters and decorators.

Definition at line 41 of file Hto4lConfig.py.

◆ __logger

python.Hto4lConfig.Hto4lConfig.__logger = Logging.logging.getLogger('Hto4lControl')

staticprivate

Setup athena-compatible logger.

Definition at line 23 of file Hto4lConfig.py.

◆ __output_events_file_name

python.Hto4lConfig.Hto4lConfig.__output_events_file_name

private

This needs to be set so that Generate_trf finds an appropriate file format for showering.

Definition at line 38 of file Hto4lConfig.py.

◆ __run_card_decorators

python.Hto4lConfig.Hto4lConfig.__run_card_decorators

private

Definition at line 44 of file Hto4lConfig.py.

◆ __run_directory

python.Hto4lConfig.Hto4lConfig.__run_directory = os.environ['PWD']

staticprivate

Set up run directory and path to Hto4l.

Definition at line 14 of file Hto4lConfig.py.

◆ _hto4l_executable

string python.Hto4lConfig.Hto4lConfig._hto4l_executable = 'Hto4l'

staticprivate

This must be defined by each derived class - don't change it in the jobOptions! _hto4l_executable = __hto4l_directory + '/Hto4l/Hto4l-v2.0/Hto4l' for local copy of Hto4l use: _hto4l_executable = __hto4l_directory + '/runGrid/Hto4l' For the lcg version of Hto4l use: _hto4l_executable = __hto4l_directory + '/Hto4l'.

Definition at line 33 of file Hto4lConfig.py.

◆ nEvents

python.Hto4lConfig.Hto4lConfig.nEvents

Add universal functionality.

Initialise values from runArgs

Definition at line 55 of file Hto4lConfig.py.

◆ random_seed

python.Hto4lConfig.Hto4lConfig.random_seed

Definition at line 57 of file Hto4lConfig.py.

◆ running_process

python.Hto4lConfig.Hto4lConfig.running_process

Initialise timer.

Initialise generation process tracker

Definition at line 118 of file Hto4lConfig.py.

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

Hto4lConfig.py

Public Member Functions

Public Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ add_parameter()

◆ add_parameter_set()

◆ configurable_parameters()

◆ emit_heartbeat()

◆ fix_parameter()

◆ fixed_parameters()

◆ generate()

◆ generateEvents()

◆ generateRunCard()

◆ logger()

◆ run_card_decorators()

◆ run_card_path()

◆ run_directory()

◆ runHto4l()

Member Data Documentation

◆ __configurable_parameters

◆ __enable_reweighting

◆ __fixed_parameters

◆ __logger

◆ __output_events_file_name

◆ __run_card_decorators

◆ __run_directory

◆ _hto4l_executable

◆ nEvents

◆ random_seed

◆ running_process

◆ init()