HPS-MC
LHECount Class Reference

Count events in an LHE file. More...

Inheritance diagram for LHECount:
Component

Public Member Functions

def __init__ (self, minevents=0, fail_on_underflow=False, **kwargs)
 
def setup (self)
 Setup LHECount component. More...
 
def cmd_exists (self)
 Check if command exists. More...
 
def execute (self, log_out, log_err)
 Execute LHECount component. More...
 
- Public Member Functions inherited from Component
def __init__ (self, name, command=None, nevents=None, seed=1, inputs=[], outputs=None, append_tok=None, output_ext=None, ignore_job_params=[], **kwargs)
 
def cmd_line_str (self)
 
def cmd_args (self)
 Return the command arguments of this component. More...
 
def cmd_args_str (self)
 Return list of arguments, making sure they are all converted to strings. More...
 
def cleanup (self)
 Perform post-job cleanup such as deleting temporary files. More...
 
def config_logging (self, parser)
 Configure the logging for a component. More...
 
def config (self, parser)
 Automatic configuration. More...
 
def set_parameters (self, params)
 Set class attributes for the component based on JSON parameters. More...
 
def required_parameters (self)
 Return a list of required parameters. More...
 
def optional_parameters (self)
 Return a list of optional parameters. More...
 
def required_config (self)
 Return a list of required configuration settings. More...
 
def check_config (self)
 Raise an exception on the first missing config setting for this component. More...
 
def input_files (self)
 Get a list of input files for this component. More...
 
def output_files (self)
 Return a list of output files created by this component. More...
 
def config_from_environ (self)
 Configure component from environment variables which are just upper case versions of the required config names set in the shell environment. More...
 

Public Attributes

 minevents
 
- Public Attributes inherited from Component
 name
 
 command
 
 nevents
 
 seed
 
 inputs
 
 outputs
 
 append_tok
 
 output_ext
 
 ignore_job_params
 
 hpsmc_dir
 
 logger
 

Detailed Description

Count events in an LHE file.

Definition at line 1308 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  minevents = 0,
  fail_on_underflow = False,
**  kwargs 
)

Definition at line 1313 of file tools.py.

Member Function Documentation

◆ cmd_exists()

def cmd_exists (   self)

Check if command exists.

Returns
True if command exists

Reimplemented from Component.

Definition at line 1324 of file tools.py.

◆ execute()

def execute (   self,
  log_out,
  log_err 
)

Execute LHECount component.

Reimplemented from Component.

Definition at line 1331 of file tools.py.

◆ setup()

def setup (   self)

Setup LHECount component.

Reimplemented from Component.

Definition at line 1319 of file tools.py.

Member Data Documentation

◆ minevents

minevents

Definition at line 1314 of file tools.py.


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