StdHepTool Class Reference

Generic class for StdHep tools. More...

Inheritance diagram for StdHepTool:

Public Member Functions
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_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...

Static Public Attributes
list	seed_names
	List of commands which accept a 'seed' argument. 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

Generic class for StdHep tools.

Todo:

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

Definition at line 468 of file tools.py.

Constructor & Destructor Documentation

__init__()

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

Reimplemented in MergePoisson.

Definition at line 483 of file tools.py.

Member Function Documentation

cmd_args()

def cmd_args

(

self

)

Setup command arguments.

Returns

list of arguments

Reimplemented from Component.

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

Definition at line 490 of file tools.py.

Member Data Documentation

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 474 of file tools.py.

---

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

• python/hpsmc/tools.py