HPS-MC
JobManager Class Reference

Run the hps-java JobManager class. More...

Inheritance diagram for JobManager:
Component

Public Member Functions

def __init__ (self, steering=None, **kwargs)
 
def config (self, parser)
 Configure JobManager component. More...
 
def required_config (self)
 Return list of required configurations. More...
 
def setup (self)
 Setup JobManager component. More...
 
def cmd_args (self)
 Setup command arguments. More...
 
def required_parameters (self)
 Return list of required parameters. More...
 
def optional_parameters (self)
 Return list of optional parameters. 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 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 set_parameters (self, params)
 Set class attributes for the component based on JSON parameters. 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...
 

Public Attributes

 run_number
 
 nevents
 nevents More...
 
 detector
 detector name More...
 
 event_print_interval
 event print interval More...
 
 defs
 
 java_args
 java arguments More...
 
 logging_config_file
 file for config logging More...
 
 lcsim_cache_dir
 lcsim cache directory More...
 
 conditions_user
 no idea More...
 
 conditions_password
 no idea More...
 
 conditions_url
 no idea More...
 
 steering
 steering file More...
 
 hps_java_bin_jar
 location of hps-java installation? More...
 
 overlay_file
 
 append_tok
 
 steering_file
 
- Public Attributes inherited from Component
 name
 
 command
 
 nevents
 
 seed
 
 inputs
 
 outputs
 
 append_tok
 
 output_ext
 
 ignore_job_params
 
 hpsmc_dir
 
 logger
 

Detailed Description

Run the hps-java JobManager class.

Input files have slcio format.

Required parameters are: steering_files
Optional parameters are: detector, run_number, defs

Definition at line 160 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 170 of file tools.py.

Member Function Documentation

◆ cmd_args()

def cmd_args (   self)

Setup command arguments.

Returns
list of arguments

Reimplemented from Component.

Definition at line 249 of file tools.py.

◆ config()

def config (   self,
  parser 
)

Configure JobManager component.

Reimplemented from Component.

Definition at line 216 of file tools.py.

◆ optional_parameters()

def optional_parameters (   self)

Return list of optional parameters.

Optional parameters are: detector, run_number, defs

Returns
list of optional parameters

Reimplemented from Component.

Definition at line 334 of file tools.py.

◆ required_config()

def required_config (   self)

Return list of required configurations.

Required configurations are: hps_java_bin_jar @retun list of required configurations.

Reimplemented from Component.

Definition at line 231 of file tools.py.

◆ required_parameters()

def required_parameters (   self)

Return list of required parameters.

Required parameters are: steering_files

Returns
list of required parameters

Reimplemented from Component.

Definition at line 325 of file tools.py.

◆ setup()

def setup (   self)

Setup JobManager component.

Reimplemented from Component.

Definition at line 240 of file tools.py.

Member Data Documentation

◆ append_tok

append_tok

Definition at line 213 of file tools.py.

◆ conditions_password

conditions_password

no idea

Definition at line 191 of file tools.py.

◆ conditions_url

conditions_url

no idea

Definition at line 193 of file tools.py.

◆ conditions_user

conditions_user

no idea

Definition at line 189 of file tools.py.

◆ defs

defs
Todo:
what is this?

Definition at line 181 of file tools.py.

◆ detector

detector

detector name

Definition at line 177 of file tools.py.

◆ event_print_interval

event_print_interval

event print interval

Definition at line 179 of file tools.py.

◆ hps_java_bin_jar

hps_java_bin_jar

location of hps-java installation?

Definition at line 197 of file tools.py.

◆ java_args

java_args

java arguments

Definition at line 183 of file tools.py.

◆ lcsim_cache_dir

lcsim_cache_dir

lcsim cache directory

Definition at line 187 of file tools.py.

◆ logging_config_file

logging_config_file

file for config logging

Definition at line 185 of file tools.py.

◆ nevents

nevents

nevents

Definition at line 175 of file tools.py.

◆ overlay_file

overlay_file

Definition at line 200 of file tools.py.

◆ run_number

run_number
Todo:
verify these definitions run number

Definition at line 173 of file tools.py.

◆ steering

steering

steering file

Definition at line 195 of file tools.py.

◆ steering_file

steering_file

Definition at line 247 of file tools.py.


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