HPS-MC
 
Loading...
Searching...
No Matches
ProcessMiniDst Class Reference

Run the make_mini_dst command on the input file. More...

Inheritance diagram for ProcessMiniDst:
Component

Public Member Functions

 __init__ (self, **kwargs)
 Initialize ProcessMiniDst with default input file and the command to run.
 
 setup (self)
 Setup the MiniDST component.
 
 required_parameters (self)
 Return list of required parameters.
 
 optional_parameters (self)
 Return list of optional parameters.
 
 required_config (self)
 Return list of required configs.
 
 output_files (self)
 Adjust names of output files.
 
 cmd_args (self)
 Setup command arguments for make_mini_dst.
 
- 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.
 
 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.
 
 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.
 
 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

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

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

Run the make_mini_dst command on the input file.

Required parameters are: input_file Required configs are: minidst_install_dir

Definition at line 446 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
**  kwargs 
)

Initialize ProcessMiniDst with default input file and the command to run.

Reimplemented from Component.

Definition at line 454 of file tools.py.

Member Function Documentation

◆ cmd_args()

cmd_args (   self)

Setup command arguments for make_mini_dst.

Returns
list of arguments

Reimplemented from Component.

Definition at line 512 of file tools.py.

◆ optional_parameters()

optional_parameters (   self)

Return list of optional parameters.

There are currently no optional parameters.

Returns
list of optional parameters

Reimplemented from Component.

Definition at line 485 of file tools.py.

◆ output_files()

output_files (   self)

Adjust names of output files.

Reimplemented from Component.

Definition at line 503 of file tools.py.

◆ required_config()

required_config (   self)

Return list of required configs.

Required configs are: minidst_install_dir

Returns
list of required configs

Reimplemented from Component.

Definition at line 494 of file tools.py.

◆ required_parameters()

required_parameters (   self)

Return list of required parameters.

Required parameters are only the standard "input_files".

Returns
list of required parameters

Reimplemented from Component.

Definition at line 476 of file tools.py.

◆ setup()

setup (   self)

Setup the MiniDST component.

Reimplemented from Component.

Definition at line 467 of file tools.py.

Member Data Documentation

◆ input_file

input_file

Definition at line 458 of file tools.py.

◆ minidst_args

minidst_args

Definition at line 459 of file tools.py.

◆ minidst_install_dir

minidst_install_dir

Definition at line 473 of file tools.py.

◆ outputs

outputs

Definition at line 507 of file tools.py.


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