RHESSysCalibrator  2.1.0
Public Member Functions | Public Attributes | List of all members
rhessyscalibrator.calibration_runner.CalibrationRunner Class Reference

Abstract super class for all consumer objects that run ModelRun objects placed in a dispatch queue by a producer thread. More...

Inheritance diagram for rhessyscalibrator.calibration_runner.CalibrationRunner:
rhessyscalibrator.calibration_runner.CalibrationRunnerQueue rhessyscalibrator.calibration_runner.CalibrationRunnerQueue rhessyscalibrator.calibration_runner.CalibrationRunnerQueue rhessyscalibrator.calibration_runner.CalibrationRunnerSubprocess rhessyscalibrator.calibration_runner.CalibrationRunnerSubprocess rhessyscalibrator.calibration_runner.CalibrationRunnerSubprocess rhessyscalibrator.calibration_runner.CalibrationRunnerLSF rhessyscalibrator.calibration_runner.CalibrationRunnerLSF rhessyscalibrator.calibration_runner.CalibrationRunnerLSF rhessyscalibrator.calibration_runner.CalibrationRunnerPBS rhessyscalibrator.calibration_runner.CalibrationRunnerPBS rhessyscalibrator.calibration_runner.CalibrationRunnerPBS rhessyscalibrator.calibration_runner.CalibrationRunnerSLURM rhessyscalibrator.calibration_runner.CalibrationRunnerSLURM rhessyscalibrator.calibration_runner.CalibrationRunnerLSF rhessyscalibrator.calibration_runner.CalibrationRunnerLSF rhessyscalibrator.calibration_runner.CalibrationRunnerLSF rhessyscalibrator.calibration_runner.CalibrationRunnerPBS rhessyscalibrator.calibration_runner.CalibrationRunnerPBS rhessyscalibrator.calibration_runner.CalibrationRunnerPBS rhessyscalibrator.calibration_runner.CalibrationRunnerSLURM rhessyscalibrator.calibration_runner.CalibrationRunnerSLURM rhessyscalibrator.calibration_runner.CalibrationRunnerLSF rhessyscalibrator.calibration_runner.CalibrationRunnerLSF rhessyscalibrator.calibration_runner.CalibrationRunnerLSF rhessyscalibrator.calibration_runner.CalibrationRunnerPBS rhessyscalibrator.calibration_runner.CalibrationRunnerPBS rhessyscalibrator.calibration_runner.CalibrationRunnerPBS rhessyscalibrator.calibration_runner.CalibrationRunnerSLURM rhessyscalibrator.calibration_runner.CalibrationRunnerSLURM

Public Member Functions

def __init__
 
def __del__ (self)
 
def run (self)
 
def storeJobInDB (self, job)
 Store new job in ModelRunnerDB2. More...
 
def jobCompleteCallback (self, args, kwargs)
 Called when a job is complete. More...
 
def __init__
 
def __del__ (self)
 
def run (self)
 
def storeJobInDB (self, job)
 Store new job in ModelRunnerDB2. More...
 
def jobCompleteCallback (self, args, kwargs)
 Called when a job is complete. More...
 
def __init__
 
def __del__ (self)
 
def run (self)
 
def storeJobInDB (self, job)
 Store new job in ModelRunnerDB2. More...
 
def jobCompleteCallback (self, args, kwargs)
 Called when a job is complete. More...
 

Public Attributes

 basedir
 
 session_id
 
 queue
 
 db_path
 
 run_path
 
 logger
 
 restart_runs
 
 db
 
 numActiveJobs
 

Detailed Description

Abstract super class for all consumer objects that run ModelRun objects placed in a dispatch queue by a producer thread.

Subclasses must implement the run method.

Subclasses may override default implementation for self.jobCompleteCallback() if they wish to perform an action when a job is marked as complete.

Constructor & Destructor Documentation

def rhessyscalibrator.calibration_runner.CalibrationRunner.__init__ (   self,
  basedir,
  session_id,
  queue,
  db_path,
  run_path,
  logger,
  restart_runs = False 
)
Parameters
basedirString representing the basedir of the calibration session
session_idInteger representing the session ID of current calibration session
queueReference to Queue.Queue representing dispatch queue shared with producer thread
db_pathString representing the path of sqlite DB to store the job (run) in
run_pathString representing the absolute path of the directory from which jobs should be run.
loggerlogging.Logger to use to for debug messages
restart_runsBoolean indicating that runs are to be restarted (i.e. do not insert new runs into DB)
def rhessyscalibrator.calibration_runner.CalibrationRunner.__del__ (   self)
def rhessyscalibrator.calibration_runner.CalibrationRunner.__init__ (   self,
  basedir,
  session_id,
  queue,
  db_path,
  run_path,
  logger,
  restart_runs = False 
)
Parameters
basedirString representing the basedir of the calibration session
session_idInteger representing the session ID of current calibration session
queueReference to Queue.Queue representing dispatch queue shared with producer thread
db_pathString representing the path of sqlite DB to store the job (run) in
run_pathString representing the absolute path of the directory from which jobs should be run.
loggerlogging.Logger to use to for debug messages
restart_runsBoolean indicating that runs are to be restarted (i.e. do not insert new runs into DB)
def rhessyscalibrator.calibration_runner.CalibrationRunner.__del__ (   self)
def rhessyscalibrator.calibration_runner.CalibrationRunner.__init__ (   self,
  basedir,
  session_id,
  queue,
  db_path,
  run_path,
  logger,
  restart_runs = False 
)
Parameters
basedirString representing the basedir of the calibration session
session_idInteger representing the session ID of current calibration session
queueReference to Queue.Queue representing dispatch queue shared with producer thread
db_pathString representing the path of sqlite DB to store the job (run) in
run_pathString representing the absolute path of the directory from which jobs should be run.
loggerlogging.Logger to use to for debug messages
restart_runsBoolean indicating that runs are to be restarted (i.e. do not insert new runs into DB)
def rhessyscalibrator.calibration_runner.CalibrationRunner.__del__ (   self)

Member Function Documentation

def rhessyscalibrator.calibration_runner.CalibrationRunner.jobCompleteCallback (   self,
  args,
  kwargs 
)

Called when a job is complete.

def rhessyscalibrator.calibration_runner.CalibrationRunner.jobCompleteCallback (   self,
  args,
  kwargs 
)

Called when a job is complete.

def rhessyscalibrator.calibration_runner.CalibrationRunner.jobCompleteCallback (   self,
  args,
  kwargs 
)

Called when a job is complete.

def rhessyscalibrator.calibration_runner.CalibrationRunner.run (   self)
def rhessyscalibrator.calibration_runner.CalibrationRunner.run (   self)
def rhessyscalibrator.calibration_runner.CalibrationRunner.run (   self)
def rhessyscalibrator.calibration_runner.CalibrationRunner.storeJobInDB (   self,
  job 
)

Store new job in ModelRunnerDB2.

Parameters
jobModelRun2 object representing the new job
Note
Will set job.id based on ID of inserted run.
def rhessyscalibrator.calibration_runner.CalibrationRunner.storeJobInDB (   self,
  job 
)

Store new job in ModelRunnerDB2.

Parameters
jobModelRun2 object representing the new job
Note
Will set job.id based on ID of inserted run.
def rhessyscalibrator.calibration_runner.CalibrationRunner.storeJobInDB (   self,
  job 
)

Store new job in ModelRunnerDB2.

Parameters
jobModelRun2 object representing the new job
Note
Will set job.id based on ID of inserted run.

Member Data Documentation

rhessyscalibrator.calibration_runner.CalibrationRunner.basedir
rhessyscalibrator.calibration_runner.CalibrationRunner.db
rhessyscalibrator.calibration_runner.CalibrationRunner.db_path
rhessyscalibrator.calibration_runner.CalibrationRunner.logger
rhessyscalibrator.calibration_runner.CalibrationRunner.numActiveJobs
rhessyscalibrator.calibration_runner.CalibrationRunner.queue
rhessyscalibrator.calibration_runner.CalibrationRunner.restart_runs
rhessyscalibrator.calibration_runner.CalibrationRunner.run_path
rhessyscalibrator.calibration_runner.CalibrationRunner.session_id

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