Package schrodinger :: Package application :: Package desmond :: Module gui :: Class GuiApp

Class GuiApp

                                               object --+            
                                                        |            
ui.qt.appframework2.maestro_callback.MaestroCallbackMixin --+        
                                                            |        
                                               object --+   |        
                                                        |   |        
                  ui.qt.appframework2.markers.MarkerMixin --+        
                                                            |        
                                               object --+   |        
                                                        |   |        
               ui.qt.appframework2.settings.SettingsMixin --+        
                                                            |        
               ui.qt.appframework2.baseapp.ValidatedPanel --+        
                                                            |        
                                  ui.qt.appframework2.af2.App --+    
                                                                |    
                                   ui.qt.appframework2.af2.JobApp --+
                                                                    |
                                                                   GuiApp

Base class of several Desmond panel GUI's (see its subclasses below).

Instance Methods

[hide private]

__init__(self, key, validator, tag_func, sim_class, is_replica_exchange=False)
x.__init__(...) initializes x; see help(type(x)) for signature

setup(self)

jobDir(self)
Prevents AF2 from creating a job directory, for backwards compatability.

createJobDir(self)
Prevents AF2 from creating a job directory, for backwards compatability.

getConfigDialog(self)

enableSimulationGroupBox(self, state)
Set the simulation group box enabled state

model_changed_callback(self, model)
The GUI is designed to have some intelligence that can adapt its own look based on the imported model system.

updateFromKey(self, key)
Updates the look of the GUI with `key'.

_check_validity(self)
Checks if all widgets have valid values.

_update_key(self)
Update the `self._key' based on the GUI settings.

_submit_job(self, jobname, incorp, host, cpu, sys_fname, cfg_fname=None, really_start=True)
`cpu' should be the total number of CPUs.

_submit_multisim_job(self, jobname, incorp, whost, chost, cpus, maxjob, sys_fname, cfg_fname, msj_fname, out_fname, other_options=[], really_start=True)

_set_detail(self, n_cpu)

verifySettings(self)
Called by AppFramework to verify that all UI elements have valid states.

startCommand(self, really_start=True)
Writes the job input files and assembles the command to execute.

_write_msj(self, jobname, msj_str)

_write_cms(self, jobname)

_write_cfg(self, jobname)
self is MDApp self.sim is MdGroup

_get_msj(self, cfg_fname)

readActionSelected(self)
Called when the "Read" action is selected by the user.

writeCommand(self)

readCommand(self, fname)

isKeyConsistentWithPanel(self, key)

reset(self)

setDefaults(self)
Resets the parameters to their default values.

closeEvent(self, event)
Hide panel, if in Maestro.

Inherited from ui.qt.appframework2.af2.JobApp: cleanup, cleanupWriteCmd, cmdListToCmd, configDialogSettings, createBottomBar, generateStatus, getCmdListArgValue, jobname, jobnameData, jobnameDataChanged, launchJobCmd, launchLauncher, launchScript, launcherToCmdList, layOut, makeLauncher, registerJob, runMaestro, sanitizeJobnameText, setConfigDialogSettings, setJobname, setPanelOptions, setupJobCmd, showSTUDialog, syncConfigDialog, updateJobname, updateStatusBar, writeJobCmd

Inherited from ui.qt.appframework2.af2.JobApp (private): _addCmdParam, _getSHFilename, _getSTUZIPFilename, _getStandardJobnames, _makeLocaleIndependent, _periodicJobCheck, _populateEmptyJobname, _settings, _start, _startOrWrite, _write, _writeSTU

Inherited from ui.qt.appframework2.af2.App: createInputSelector, defineCustomSettings, getAliasedValue, getPanelState, getWorkspaceStructure, loadPanelState, setAliasedValue, setPanelState, showEvent, showProgressBarForJob, writePanelState

Inherited from ui.qt.appframework2.af2.App (private): _close, _configurePanelSettings, _help, _read, _reset, _statusShrunk, _updateProgressBar

Inherited from ui.qt.appframework2.maestro_callback.MaestroCallbackMixin: buildCallbackDicts

Inherited from ui.qt.appframework2.maestro_callback.MaestroCallbackMixin (private): _addCallbacks, _delayedCallbacks, _removeCallbacks

Inherited from ui.qt.appframework2.markers.MarkerMixin: addMarker, getAllMarkers, getMarker, hideAllMarkers, removeAllMarkers, removeAllMarkersForEntry, removeMarker, removeMarkerForAtoms, showAllMarkers

Inherited from ui.qt.appframework2.markers.MarkerMixin (private): _calcEntryAtomTotal, _canonicalizeAtomOrder, _clearInvalidatedMarkers, _createMarker, _eidsFromHashable, _genMarkerHash, _updateMarkers

Inherited from ui.qt.appframework2.settings.SettingsMixin: __getitem__, __setitem__, applySettings, getAliasedSettings, getObjValue, getSettings, setAlias, setAliases, setObjValue

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

Class Methods

[hide private]

Inherited from ui.qt.appframework2.af2.App: panel

Class Variables

[hide private]

Inherited from ui.qt.appframework2.af2.JobApp: lastJobCompleted

Inherited from ui.qt.appframework2.af2.App (private): _singleton

Instance Variables

[hide private]

Inherited from ui.qt.appframework2.markers.MarkerMixin: MARKER_ICONS

Inherited from ui.qt.appframework2.markers.MarkerMixin (private): _marked_eid_lengths, _markers

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, key, validator, tag_func, sim_class, is_replica_exchange=False)
(Constructor)

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

setup(self)

Overrides: ui.qt.appframework2.af2.App.setup

jobDir(self)

Prevents AF2 from creating a job directory, for backwards compatability. With these methods in place, job files are written to the Maestro's CWD.

Overrides: ui.qt.appframework2.af2.JobApp.jobDir

createJobDir(self)

Prevents AF2 from creating a job directory, for backwards compatability. With these methods in place, job files are written to the Maestro's CWD.

Overrides: ui.qt.appframework2.af2.JobApp.createJobDir

getConfigDialog(self)

Overrides: ui.qt.appframework2.af2.JobApp.getConfigDialog

enableSimulationGroupBox(self, state)

Set the simulation group box enabled state

Parameters:

state (bool) - True if the groupbox should be enabled, False if not

model_changed_callback(self, model)

The GUI is designed to have some intelligence that can adapt its own look based on the imported model system. So if the model system is changed, we need to inform some other parts of the GUI.

The event that the model system is changed will be initially triggered from the `InputGroup' (see this class above), then it will go to here (i.e., `GuiApp'), and from here the signal will be sent forth to all interested parts of the GUI.

`model' - A `cms.Cms' object, containing all information about the model system.

If it is none, then the model is a checkpoint file.

_check_validity(self)

Checks if all widgets have valid values. If a widget with invalid value was encountered, then returns string that describes the problem. Returns None if there are no issues.

_submit_job(self, jobname, incorp, host, cpu, sys_fname, cfg_fname=None, really_start=True)

`cpu' should be the total number of CPUs. For REMD jobs, the total number of CPUs = number of CPUs for each replica times number of replicas.

verifySettings(self)

Called by AppFramework to verify that all UI elements have valid states. Returns True if so. Returns False and the error message if any issues are found.

Decorators:

@af2.validator()

startCommand(self, really_start=True)

Writes the job input files and assembles the command to execute.

Parameters:

really_start (bol) - Whether to start the job after writing the input files.

Decorators:

@af2.appmethods.start()

readActionSelected(self)

Called when the "Read" action is selected by the user. It's the responsibility of individual panels to hook this method to the "Read" menu action. See Ev:109801

writeCommand(self)

Decorators:

@af2.appmethods.write("Write")

reset(self)

Decorators:

@af2.appmethods.reset('Reset')

setDefaults(self)

Resets the parameters to their default values.

Decorators:

@wait_cursor

Overrides: ui.qt.appframework2.af2.JobApp.setDefaults

closeEvent(self, event)

Hide panel, if in Maestro. Otherwise close it.

Overrides: ui.qt.appframework2.markers.MarkerMixin.closeEvent

Class GuiApp

__init__(self, key, validator, tag_func, sim_class, is_replica_exchange=False) (Constructor)

setup(self)

jobDir(self)

createJobDir(self)

getConfigDialog(self)

enableSimulationGroupBox(self, state)

model_changed_callback(self, model)

_check_validity(self)

_submit_job(self, jobname, incorp, host, cpu, sys_fname, cfg_fname=None, really_start=True)

verifySettings(self)

startCommand(self, really_start=True)

readActionSelected(self)

writeCommand(self)

reset(self)

setDefaults(self)

closeEvent(self, event)

init(self, key, validator, tag_func, sim_class, is_replica_exchange=False)
(Constructor)