Event generator base class. More...
Public Member Functions | |
__init__ (self, name, command=None, **kwargs) | |
required_parameters (self) | |
Return a list of required parameters. | |
get_install_dir (self) | |
![]() | |
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 (self) | |
Return the command arguments of this component. | |
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. | |
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. | |
Additional Inherited Members | |
![]() | |
name | |
command | |
nevents | |
seed | |
inputs | |
outputs | |
append_tok | |
output_ext | |
ignore_job_params | |
hpsmc_dir | |
logger | |
![]() | |
_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. | |
Event generator base class.
Definition at line 13 of file generators.py.
__init__ | ( | self, | |
name, | |||
command = None , |
|||
** | kwargs | ||
) |
Reimplemented from Component.
Reimplemented in MG, StdHepConverter, EGS5, MG4, and MG5.
Definition at line 16 of file generators.py.
get_install_dir | ( | self | ) |
Reimplemented in EGS5, MG4, and MG5.
Definition at line 22 of file generators.py.
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 EGS5, and MG.
Definition at line 19 of file generators.py.