HPS-MC
MergeFiles Class Reference

Merge StdHep files. More...

Inheritance diagram for MergeFiles:
StdHepTool Component

Public Member Functions

def __init__ (self, **kwargs)
 
def optional_parameters (self)
 Return list of optional parameters. More...
 
def required_parameters (self)
 Return list of required parameters. More...
 
- Public Member Functions inherited from StdHepTool
def __init__ (self, name=None, **kwargs)
 
def cmd_args (self)
 Setup command arguments. 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 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_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 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
 
- Static Public Attributes inherited from StdHepTool
list seed_names
 List of commands which accept a 'seed' argument. More...
 

Detailed Description

Merge StdHep files.

Optional parameters are: none
Required parameters are: none

Definition at line 846 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
**  kwargs 
)

Definition at line 854 of file tools.py.

Member Function Documentation

◆ optional_parameters()

def optional_parameters (   self)

Return list of optional parameters.

Optional parameters are: none

Returns
list of optional parameters

Reimplemented from Component.

Definition at line 859 of file tools.py.

◆ required_parameters()

def required_parameters (   self)

Return list of required parameters.

Required parameters are: none

Returns
list of required parameters

Reimplemented from Component.

Definition at line 868 of file tools.py.


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