Package schrodinger :: Package test :: Package scival :: Module suite :: Class BaseSuiteJob

[frames] | no frames]

Class BaseSuiteJob

         object --+        
                  |        
  job.queue.BaseJob --+    
                      |    
job.queue.JobControlJob --+
                          |
             object --+   |
                      |   |
             _SciValJob --+
                          |
                         BaseSuiteJob

Known Subclasses:

SuiteJob

Instance Methods

__init__(self, command, command_dir=None, name=None, suite='', max_retries=None, launch_env_variables=None, **kwargs)
Job constructor.

Inherited from job.queue.JobControlJob: __getstate__, __setstate__, __str__, cancelSubmitted, doCommand, getCommand, getJob, getStatusStrings, kill, maxFailuresReached, retryFailure, runsLocally, update, usesJobServer

Inherited from job.queue.JobControlJob (private): _downloadFromJobServer, _hasDied, _launch_with_retries, _markFinished, _readAgain

Inherited from job.queue.BaseJob: __lt__, addFinalizer, addGroupPrereq, addPrereq, finalize, genAllJobs, genAllPrereqs, getCommandDir, getJobDJ, getPrereqs, hasStarted, isComplete, postCommand, preCommand, run, setup

Inherited from job.queue.BaseJob (private): _getState, _pruneGraph, _setState

Inherited from _SciValJob: suiteName, testName

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Variables

Inherited from job.queue.BaseJob: init_count

Properties

Inherited from job.queue.BaseJob: state

Inherited from object: __class__

Method Details

init(self, command, command_dir=None, name=None, suite=`''`, max_retries=None, launch_env_variables=None, **kwargs)
(Constructor)

Job constructor.

Parameters:

command - The command that runs the job.
command_dir - The directory from which to run the command.
name - The name of the job.
max_retries - Number of allowed retries for this job. If this is set, it is never overridden by the SCHRODINGER_MAX_RETRIES environment variable. If it is not set, the value of max_retries defined in JobDJ is used, and SCHRODINGER_MAX_RETRIES can be used to override this value at runtime. To prevent this job from being restarted altogether, set max_retries to zero.
timeout - Timeout (in seconds) after which the job will be killed. If None, the job is allowed to run indefinitely.
launch_env_variables - A dictionary with the environment variables to add when the jobcontrol job is launched. The name of any additional variables to set should be in the keyword of the dict and the value should be the corresponding value. These will be added to any environment variables already present, but removed after the job has been launched.
kwargs - Additional keyword arguments. Provided for consistency of interface in subclasses.

Overrides: object.__init__

(inherited documentation)