Herwig7Utils Namespace Reference

Classes
class	ConfigurationCommands
	Class for handling commands to modify the generator configuration. More...
class	Process
	Class for handling a single process. More...
class	ProcessHandler
	Class for handling parallel local multi-processing. More...

Functions
	get_cross_section (run_name, integration_jobs=1)
	Calculate the total cross section from the integration log files.
	get_repeated_pattern (pattern, repetitions)
	Return a string made up of a certain number of repetitions of the same pattern.
	get_size (path)
	Get size of file or folder.
	humanize_bytes (bytes, precision=2)
	Convert file/folder size from bytes to units with appropriate prefixes (multiples of 1000, not 1024!)
	ansi_format (text, colour='None', background_colour='None', bold=False, underline=False, italics=False, marked=False, strikethrough=False)
	Format and colorize terminal output.
	ansi_format_ok (text)
	Green colouring.
	ansi_format_info (text)
	Blue colouring.
	ansi_format_warning (text)
	Yellow colouring.
	ansi_format_error (text)
	Red colouring.

Variables
	athMsgLog = Logging.logging.getLogger('Herwig7Utils')
float	integration_grids_precision_threshold = 0.0005

Function Documentation

ansi_format()

Herwig7Utils.ansi_format	(		text,
			colour = 'None',
			background_colour = 'None',
			bold = False,
			underline = False,
			italics = False,
			marked = False,
			strikethrough = False )

Format and colorize terminal output.

Definition at line 206 of file Herwig7Utils.py.

           bold=False, underline=False, italics=False, marked=False, strikethrough=False):
 
  format_none          = '\033[0m'
  format_bold          = '\033[1m'
  format_underline     = '\033[4m'
  format_italics       = '\033[3m'
  format_marked        = '\033[7m'
  format_strikethrough = '\033[9m'
 
  colours = {
    'None': '',
    'Black':     '\033[30m',
    'Grey':      '\033[90m',
    'Red':       '\033[91m', 'DarkRed':   '\033[31m',
    'Green':     '\033[92m', 'DarkGreen': '\033[32m',
    'Yellow':    '\033[93m', 'Orange':    '\033[33m',
    'Blue':      '\033[94m', 'DarkBlue':  '\033[34m',
    'Pink':      '\033[95m', 'DarkPink':  '\033[35m',
    'Cyan':      '\033[96m', 'DarkCyan':  '\033[36m',
    'White':     '\033[97m', 'LightGrey': '\033[37m',
  }
 
  background_colours = {
    'None': '',
    'Black':  '\033[40m',
    'Red':    '\033[41m',
    'Green':  '\033[42m',
    'Orange': '\033[43m',
    'Blue':   '\033[44m',
    'Punk':   '\033[45m',
    'Cyan':   '\033[46m',
    'Grey':   '\033[47m',
  }
 
  if colour in colours:
    if background_colour in background_colours:
      return (format_none
        + colours[colour]
        + background_colours[background_colour]
        + (format_bold          if bold          else '')
        + (format_underline     if underline     else '')
        + (format_italics       if italics       else '')
        + (format_marked        if marked        else '')
        + (format_strikethrough if strikethrough else '')
        + text + format_none)
    else:
      raise Exception("Could not find background colour '{}'.".format(background_colour))
  else:
    raise Exception("Could not find colour '{}'.".format(colour))
 

ansi_format_error()

Herwig7Utils.ansi_format_error

(

text

)

Red colouring.

Definition at line 270 of file Herwig7Utils.py.

def ansi_format_error(text):
  return (ansi_format(text, "Red"))
 

ansi_format_info()

Herwig7Utils.ansi_format_info

(

text

)

Blue colouring.

Definition at line 262 of file Herwig7Utils.py.

def ansi_format_info(text):
  return (ansi_format(text, "Blue"))
 

ansi_format_ok()

Herwig7Utils.ansi_format_ok

(

text

)

Green colouring.

Definition at line 258 of file Herwig7Utils.py.

def ansi_format_ok(text):
  return (ansi_format(text, "Green"))
 

ansi_format_warning()

Herwig7Utils.ansi_format_warning

(

text

)

Yellow colouring.

Definition at line 266 of file Herwig7Utils.py.

def ansi_format_warning(text):
  return (ansi_format(text, "Yellow"))
 

get_cross_section()

Herwig7Utils.get_cross_section	(		run_name,
			integration_jobs = 1 )

Calculate the total cross section from the integration log files.

Definition at line 107 of file Herwig7Utils.py.

def get_cross_section(run_name, integration_jobs=1):
 
  athMsgLog.info("Calculating cross section after integration")
  logfiles = [run_name+'.integrate'+str(integration_job)+'.log' for integration_job in range(integration_jobs)]
 
  xsec = 0.0
  err  = 0.0
 
  for logfile in logfiles:
 
    athMsgLog.info("- %s", logfile)
 
    
    with open(logfile, 'r') as log: data = log.read().strip()
 
    with open(logfile, 'r') as log:
 
      
      for line in log:
        if 'Integrate ' in line:
          n_subprocs = int(line.split('of')[1].replace(':',''))
          athMsgLog.info("  found %s subprocesses", n_subprocs)
          break
 
    data = data.split("Integrate ")[1:]
  
    for s, subproc in enumerate(data, start=1):
      _xsec = 0.0
      _err  = 0.0
      for line in subproc.split("\n"):
        if 'integrated ( ' in line:
          _xsec = float(line.split()[2])
          _err = float(line.split()[4])
      athMsgLog.info("  - subprocess %s: xsec = %s +/- %s nb", s, _xsec, _err)
      xsec += _xsec
      err  += _err*_err
 
  err = math.sqrt(err)
 
  if err / xsec > integration_grids_precision_threshold:
    threshold = '{}%'.format(integration_grids_precision_threshold*100.0)
    if run_name == "Herwig_DEBUG":
       athMsgLog.warn(ansi_format_warning('! The integration grids only have a low precision (worse than {}): xsec = {} +/- {} nb (accuracy: {:.3f}%)'.format(threshold, xsec, err, err/xsec*100.0)))
    else:
       athMsgLog.error(ansi_format_error('! The integration grids only have a low precision (worse than {}): xsec = {} +/- {} nb (accuracy: {:.3f}%)'.format(threshold, xsec, err, err/xsec*100.0)))
    athMsgLog.warn(ansi_format_warning('! In order to speed up the event generation you should consider improving the statistics of the integration / phase space sampling stage (see the sampler_commands() function).'))
  else:
    athMsgLog.info(ansi_format_info('After integration the estimated cross section was found to be: xsec = {} +/- {} nb (accuracy: {:.3f}%)'.format(xsec, err, err/xsec*100.0)))
 
  return(xsec, err)
 
 

get_repeated_pattern()

Herwig7Utils.get_repeated_pattern	(		pattern,
			repetitions )

Return a string made up of a certain number of repetitions of the same pattern.

Definition at line 160 of file Herwig7Utils.py.

def get_repeated_pattern(pattern, repetitions):
 
  return(pattern.join(['' for i in range(repetitions+1)]))
 
 

get_size()

Herwig7Utils.get_size

(

path

)

Get size of file or folder.

Definition at line 166 of file Herwig7Utils.py.

def get_size(path):
 
  size = 0
  
  if os.path.isfile(path):
    return(os.path.getsize(path))
 
  elif os.path.isdir(path):
    for dirpath, dirs, files in os.walk(path):
      for file in files:
        file_path = os.path.join(dirpath, file)
        # if not os.path.islink(file_path): # exclude symlinks because MadGraph has lots of broken symlinks
        if os.path.isfile(file_path):
          size += os.path.getsize(file_path)
 
  return(size)
 
 

humanize_bytes()

Herwig7Utils.humanize_bytes	(		bytes,
			precision = 2 )

Convert file/folder size from bytes to units with appropriate prefixes (multiples of 1000, not 1024!)

Definition at line 185 of file Herwig7Utils.py.

def humanize_bytes(bytes, precision=2):
  # shamelessly stolen from
  # http://code.activestate.com/recipes/577081-humanized-representation-of-a-number-of-bytes/
 
  abbrevs = (
      (1<<50, 'PiB'),
      (1<<40, 'TiB'),
      (1<<30, 'GiB'),
      (1<<20, 'MiB'),
      (1<<10, 'KiB'),
      (1, 'byte(s)')
  )
  if bytes == 1:
    return '1 byte'
  for factor, suffix in abbrevs:
    if bytes >= factor:
      break
  return '%.*f %s' % (precision, bytes / factor, suffix)
 
 

Variable Documentation

athMsgLog

Herwig7Utils.athMsgLog = Logging.logging.getLogger('Herwig7Utils')

Definition at line 10 of file Herwig7Utils.py.

integration_grids_precision_threshold

float Herwig7Utils.integration_grids_precision_threshold = 0.0005

Definition at line 12 of file Herwig7Utils.py.