HPS-MC
EventGenerator Class Reference

Event generator base class. More...

Inheritance diagram for EventGenerator:
Component EGS5 MG StdHepConverter MG4 MG5

Public Member Functions

def __init__ (self, name, command=None, **kwargs)
 
def required_parameters (self)
 Return a list of required parameters. More...
 
def get_install_dir (self)
 
- 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 execute (self, log_out=sys.stdout, log_err=sys.stderr)
 Generic component execution method. More...
 
def cmd_exists (self)
 Check if the component's assigned command exists. More...
 
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 setup (self)
 Perform any necessary setup for this component to run such as making symlinks to required directories. 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 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...
 

Additional Inherited Members

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

Detailed Description

Event generator base class.

Definition at line 13 of file generators.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  name,
  command = None,
**  kwargs 
)

Definition at line 16 of file generators.py.

Member Function Documentation

◆ get_install_dir()

def get_install_dir (   self)

Reimplemented in MG5, MG4, and EGS5.

Definition at line 22 of file generators.py.

◆ required_parameters()

def required_parameters (   self)

Return a list of required parameters.

The job will fail if these are not present in the JSON file.

Reimplemented from Component.

Reimplemented in MG, and EGS5.

Definition at line 19 of file generators.py.


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