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

Run the hpstr analysis tool. More...

Inheritance diagram for HPSTR:
Component

Public Member Functions

 __init__ (self, cfg=None, is_data=0, year=None, tracking=None, **kwargs)
 
 setup (self)
 Setup HPSTR 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.
 
 cmd_args (self)
 Setup command arguments.
 
 output_files (self)
 Adjust names of output files.
 
 execute (self, log_out, log_err)
 Execute HPSTR component.
 
- Public Member Functions inherited from Component
 cmd_line_str (self)
 
 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

 cfg
 configuration
 
 is_data
 run mode
 
 year
 year
 
 tracking
 tracking option (KF, GBL, BOTH)
 
 hpstr_install_dir
 
 hpstr_base
 
 env_script
 
 config_files
 
 cfg_path
 
 append_tok
 
 nevents
 
 name
 
- 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 hpstr analysis tool.

Required parameters are: config_files
Optional parameters are: year, is_data, nevents
Required configs are: hpstr_install_dir, hpstr_base

Definition at line 344 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
  cfg = None,
  is_data = 0,
  year = None,
  tracking = None,
**  kwargs 
)

Reimplemented from Component.

Definition at line 353 of file tools.py.

Member Function Documentation

◆ cmd_args()

cmd_args (   self)

Setup command arguments.

Returns
list of arguments

Reimplemented from Component.

Definition at line 425 of file tools.py.

◆ execute()

execute (   self,
  log_out,
  log_err 
)

Execute HPSTR component.

Reimplemented from Component.

Definition at line 452 of file tools.py.

◆ optional_parameters()

optional_parameters (   self)

Return list of optional parameters.

Optional parameters are: year, is_data, nevents

Returns
list of optional parameters

Reimplemented from Component.

Definition at line 407 of file tools.py.

◆ output_files()

output_files (   self)

Adjust names of output files.

Reimplemented from Component.

Definition at line 442 of file tools.py.

◆ required_config()

required_config (   self)

Return list of required configs.

Required configs are: hpstr_install_dir, hpstr_base

Returns
list of required configs

Reimplemented from Component.

Definition at line 416 of file tools.py.

◆ required_parameters()

required_parameters (   self)

Return list of required parameters.

Required parameters are: config_files

Returns
list of required parameters

Reimplemented from Component.

Definition at line 398 of file tools.py.

◆ setup()

setup (   self)

Setup HPSTR component.

Reimplemented from Component.

Definition at line 371 of file tools.py.

Member Data Documentation

◆ append_tok

append_tok

Definition at line 395 of file tools.py.

◆ cfg

cfg

configuration

Definition at line 355 of file tools.py.

◆ cfg_path

cfg_path

Definition at line 384 of file tools.py.

◆ config_files

config_files

Definition at line 379 of file tools.py.

◆ env_script

env_script

Definition at line 375 of file tools.py.

◆ hpstr_base

hpstr_base

Definition at line 364 of file tools.py.

◆ hpstr_install_dir

hpstr_install_dir

Definition at line 363 of file tools.py.

◆ is_data

is_data

run mode

Definition at line 357 of file tools.py.

◆ name

name

Definition at line 458 of file tools.py.

◆ nevents

nevents

Definition at line 435 of file tools.py.

◆ tracking

tracking

tracking option (KF, GBL, BOTH)

Definition at line 361 of file tools.py.

◆ year

year

year

Definition at line 359 of file tools.py.


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