Package gromacs :: Module qsub :: Class QueuingSystem
[hide private]
[frames] | no frames]

Class QueuingSystem

source code

object --+
         |
        QueuingSystem

Class that represents minimum information about a batch submission system.

Instance Methods [hide private]
 
__init__(self, name, suffix, qsub_prefix, array_variable=None, array_option=None)
Define a queuing system's functionality
source code
 
flag(self, *args)
Return string for qsub flag *args* prefixed with appropriate inscript prefix.
source code
 
has_arrays(self)
True if known how to do job arrays.
source code
 
array_flag(self, directories)
Return string to embed the array launching option in the script.
source code
 
array(self, directories)
Return multiline string for simple array jobs over *directories*.
source code
 
isMine(self, scriptname)
Primitive queuing system detection; only looks at suffix at the moment.
source code
 
__repr__(self)
repr(x)
source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __str__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, name, suffix, qsub_prefix, array_variable=None, array_option=None)
(Constructor)

source code 
Define a queuing system's functionality

:Arguments:
  *name*
     name of the queuing system, e.g. 'Sun Gridengine'
  *suffix*
     suffix of input files, e.g. 'sge'
  *qsub_prefix*
     prefix string that starts a qsub flag in a script, e.g. '#$'

:Keywords:
  *array_variable*
     environment variable exported for array jobs, e.g.
     'SGE_TASK_ID'
  *array_option*
     qsub option format string to launch an array (e.g. '-t %d-%d')

Overrides: object.__init__

array(self, directories)

source code 
Return multiline string for simple array jobs over *directories*.

.. Warning:: The string is in ``bash`` and hence the template must also
             be ``bash`` (and *not* ``csh`` or ``sh``).

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)