Package schrodinger :: Package job :: Module launchapi :: Class JobSpecificationBuilder
[hide private]
[frames] | no frames]

Class JobSpecificationBuilder

object --+
         |
        JobSpecificationBuilder

A helper class to create a TaskSpecification and RuntimeParameters from a specific set of command-line arguments.

Instance Methods [hide private]
 
__init__(self, args, use_schrodinger_run=True, schrodinger_product=None, use_jobname_log=False)
See TaskSpecificationBuilder.setCommandLine for argument descriptions.
 
getTaskSpec(self)
 
getRuntimeParams(self)
 
getJobSpec(self)
 
addHost(self, host)
 
setJobname(self, jobname)
 
setProgramName(self, program_name)
 
setInputFile(self, filename, key=None, jobname_source=False)
Indicate an argument as an input file.
 
setStderr(self, runtime_path, stream=False)
 
setStdout(self, runtime_path, stream=False)
 
setOutputFile(self, runtime_path, key=None, stream=False)
 
enableDebug(self)
 
disableDebug(self)
 
setDetach(self, run_detach)
 
addLicense(self, license_string, license_tokens)
 
setThreadsPerProcess(self, nthreads=1)
Set the compute setting for threads per process(TPP).
 
setNumberOfProcesses(self, nprocesses=1)
Set the compute setting for number of processes(cores) for the job.

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, args, use_schrodinger_run=True, schrodinger_product=None, use_jobname_log=False)
(Constructor)

 

See TaskSpecificationBuilder.setCommandLine for argument descriptions.

Parameters:
  • use_jobname_log - If True, set the STDOUT, STDERR as <JOBNAME>.log and stream it. Default is False.
  • schrodinger_run (bool)
Overrides: object.__init__

setNumberOfProcesses(self, nprocesses=1)

 

Set the compute setting for number of processes(cores) for the job. This alongwith TPP derive the nproc.