HPS-MC
 
All Classes Namespaces Files Functions Variables Pages
Loading...
Searching...
No Matches
StdHepTool Class Reference

Generic class for StdHep tools. More...

Inheritance diagram for StdHepTool:
Component AddMother AddMotherFullTruth BeamCoords DisplaceTime DisplaceUni MergeFiles MergePoisson RandomSample

Public Member Functions

 __init__ (self, name=None, **kwargs)
 
 cmd_args (self)
 Setup command arguments.
 
- Public Member Functions inherited from Component
 cmd_line_str (self)
 
 execute (self, log_out=sys.stdout, log_err=sys.stderr)
 Generic component execution method.
 
 cmd_exists (self)
 Check if the component's assigned command exists.
 
 cmd_args_str (self)
 Return list of arguments, making sure they are all converted to strings.
 
 setup (self)
 Perform any necessary setup for this component to run such as making symlinks to required directories.
 
 cleanup (self)
 Perform post-job cleanup such as deleting temporary files.
 
 config_logging (self, parser)
 Configure the logging for a component.
 
 config (self, parser)
 Automatic configuration.
 
 set_parameters (self, params)
 Set class attributes for the component based on JSON parameters.
 
 required_parameters (self)
 Return a list of required parameters.
 
 optional_parameters (self)
 Return a list of optional parameters.
 
 required_config (self)
 Return a list of required configuration settings.
 
 check_config (self)
 Raise an exception on the first missing config setting for this component.
 
 input_files (self)
 Get a list of input files for this component.
 
 output_files (self)
 Return a list of output files created by this component.
 
 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.
 

Public Attributes

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

Static Public Attributes

list seed_names
 List of commands which accept a 'seed' argument.
 

Additional Inherited Members

- Protected Member Functions inherited from Component
 _inputs_to_outputs (self)
 This is the default method for automatically transforming input file names to outputs when output file names are not explicitly provided.
 

Detailed Description

Generic class for StdHep tools.

Todo:
split this over several files -> move stdheptools in separate package

Definition at line 533 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from Component.

Reimplemented in BeamCoords, RandomSample, DisplaceTime, DisplaceUni, AddMother, AddMotherFullTruth, MergeFiles, and MergePoisson.

Definition at line 548 of file tools.py.

Member Function Documentation

◆ cmd_args()

cmd_args (   self)

Setup command arguments.

Returns
list of arguments

Reimplemented from Component.

Reimplemented in BeamCoords, RandomSample, DisplaceTime, DisplaceUni, AddMotherFullTruth, and MergePoisson.

Definition at line 555 of file tools.py.

Member Data Documentation

◆ seed

seed

Definition at line 563 of file tools.py.

◆ seed_names

list seed_names
static
Initial value:
= ['beam_coords',
'beam_coords_old',
'lhe_tridents',
'lhe_tridents_displacetime',
'lhe_tridents_displaceuni',
'merge_poisson',
'mix_signal',
'random_sample']

List of commands which accept a 'seed' argument.

Definition at line 539 of file tools.py.


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