Package schrodinger :: Package ui :: Package qt :: Module appframework :: Class StartDialog
[hide private]
[frames] | no frames]

Class StartDialog


Toplevel Qt widget that mimics the Maestro Start dialog.
Configuration options set via constructor keywords are...

    title -         Title for the dialog window.  Default is
                    '<parent_title> - Start'.

    command -       Function to call (not used?).

    jobname -       Initial string value for the job name entry field.
                    Default is ''.

    incorporation - Display a disposition selector for Maestro
                    incorporation.  Maestro only.  Default is True.

    default_disp -  The default disposition, if 'incorporation' is True.
                    Must be DISP_APPEND or DISP_IGNORE.
                    Default is DISP_IGNORE.

    host -          Display a pull-down menu (or a table) for selecting 
                    the host for the job. Default is True.

    multihost -     Whether to display a host table that supports multiple
                    hosts. By default, a pull-down menu is displayed.

    host_products   Products that will get their own host menu and #cpus
                    box. Not compatible with multihost or cpus3.
                    Takes a list of strings. Default is one host menu.

    localdriver -   Display a checkbutton for running driver job on the
                    localhost (Default is remote driver)

    remotedriver -  Display a checkbutton for running driver job on the
                    localhost (Default is local driver)
    
    jobentry -      Display widgets for setting the job name.
                    Default is True.

    cpus -          Display additional options for distributed jobs,
                    including the number of CPUs.  Default is False.
                    NOTE: This option is not available with multihost.

    cpus3 -         Display additional options for Desmond distributed jobs
                    which includes 3 CPUS values: X, Y, and Z.
                    Default is False.
                    NOTE: This option is not available with multihost.

    njobs -         Display widgets for running the job as a specified
                    number of subjobs.  Default is False.

    adjust -        Whether to display the "Adjust" checkbox. Default is
                    False. Requires <njobs> to be True.
    
    tmpdir -        Show the tmpdir for the currently selected host.
                    Default is False.
    
    NOTE: localdriver and remotedriver options are mutually exclusive and
          if either feature is requested, commandLineOptions() method will
          append -LOCALDRIVER or -REMOTEDRIVER to the command list, 
          depending on whether the checkbutton is checked or not.
          

Job parameters passed out in the StartDialogParams object upon
the dialog deactivating with via a "Start" (not "Cancel") action...

    proj -    The Project from which the job is launched (required for
              incorporation).  "" if not in Maestro.
    
    disp -    Maestro disposition.  'append' or 'ignore' if
              'incorporation' is True.  "" if not in Maestro.  Undefined
              if in Maestro but 'incorporation' is False.
    
    jobname - Job name.  Undefined if 'jobentry' is False.

    host -    Main host.  Undefined if 'host' option is False.
              NOTE: Hosts string (with ncpus) if multihost is set.

    localdriver - Wheather to run driver on localhost. Undefined if
                    'localdriver' & 'remotedriver' options are False

    njobs -   Number of subjobs.  Undefined if 'njobs' option is False.
    
    adjust -  Whether the user checked the "Adjust" checkbox.

    cpus -    Number of CPUs.  Undefined if 'cpus' option is False.  Set
              to 'njobs' if the "Distribute subjobs over maximum..." is
              chosen, otherwise set to the number of specified CPUs.
              NOTE: not available with multihost setting.
    
    cpus3 -   Number of CPUs as 3 numbers: X, Y, & Z. Used by the Desmond
              panels. Undefined if 'cpus3' option is False.


Please see the DialogParameters class below for usage instructions.

Instance Methods [hide private]
 
__init__(self, parent, title='', jobname='', checkcommand=None, **kw)
See class docstring.
 
_stripProcs(self, host_entry)
Returns host name minus the parenthetical available processors entry
 
activate(self)
Display the dialog and return the dialog parameters as as StartDialogParam object.
 
cpus3Edited(self, ignored=None)
 
getHosts(self, ncpus=True)
Returns list of host entries from appropriate schrodinger.hosts file, with parenthetical entry of the number of available processors (if 'ncpus' is True).
 
setupHostLayout(self)
Setup the host layout, including hostlist/table and numbers of cpus (including cpus3).
 
startPressed(self)
 
warning(self, text)
Display a warning window with the specified text.
Class Variables [hide private]
  CANCEL = 'Cancel'
  START = 'Start'
Method Details [hide private]

__init__(self, parent, title='', jobname='', checkcommand=None, **kw)
(Constructor)

 

See class docstring. Raises an Exception if the disposition specified as the default is not recognized.

If pre_close_command is specified, it will be run when the user presses the Start button. The dialog is only closed if that function returns 0.

activate(self)

 

Display the dialog and return the dialog parameters as as StartDialogParam object. If the dialog was cancelled then return None