Package schrodinger :: Package application :: Package matsci :: Module guibase :: Class MultiJobApp

Class MultiJobApp

                                                       object --+                
                                                                |                
ui.qt.appframework2.maestro_callback.AbstractMaestroCallbackMixin --+            
                                                                    |            
            ui.qt.appframework2.maestro_callback.MaestroCallbackMixin --+        
                                                                        |        
                                                           object --+   |        
                                                                    |   |        
                              ui.qt.appframework2.markers.MarkerMixin --+        
                                                                        |        
                                                       object --+       |        
                                                                |       |        
                       ui.qt.appframework2.settings.SettingsMixin --+   |        
                                                                    |   |        
                      ui.qt.appframework2.settings.SettingsPanelMixin --+        
                                                                        |        
                                       object --+                       |        
                                                |                       |        
                                sip.simplewrapper --+                   |        
                                                    |                   |        
                                          sip.wrapper --+               |        
                                                        |               |        
                                     PyQt5.QtCore.QObject --+           |        
                                                            |           |        
                                           object --+       |           |        
                                                    |       |           |        
                                    sip.simplewrapper --+   |           |        
                                                        |   |           |        
                                 PyQt5.QtGui.QPaintDevice --+           |        
                                                            |           |        
                                      PyQt5.QtWidgets.QWidget --+       |        
                                                                |       |        
                            ui.qt.appframework2.baseapp.BasePanel --+   |        
                                                                    |   |        
                                                       object --+   |   |        
                                                                |   |   |        
                   ui.qt.appframework2.validation.ValidationMixin --+   |        
                                                                    |   |        
                           ui.qt.appframework2.baseapp.ValidatedPanel --+        
                                                                        |        
                                              ui.qt.appframework2.af2.App --+    
                                                                            |    
                                               ui.qt.appframework2.af2.JobApp --+
                                                                                |
                                                                               MultiJobApp

Known Subclasses:

MultiDesmondJobApp

Subclass of AF2 JobApp that allows launching multiple simultanious jobs.

Every panel subclassing this should re-implement getJobCount() and getJobSpec() methods. A start method should NOT be implemented.

Nested Classes

[hide private]

Inherited from PyQt5.QtWidgets.QWidget: RenderFlag, RenderFlags

Inherited from PyQt5.QtGui.QPaintDevice: PaintDeviceMetric

Instance Methods

[hide private]

False or None

_startOrWrite(self)
Over-riden method from JobApp class.

validateJobCount(self)

bool

_preLaunchValidate(self)
Run validation before starting/writing jobs.

showLaunchStatus(self, num_succeeded, njobs)
Show a label at the bottom of the panel with status of the launch.

int

getJobCount(self)
Over-ride in the subclass to return the number of jobs that the user would like to start.

multiJobStart(self)
Custom "start" method.

launchFromJobSpec(self, sub_jobname, job_num, oplsdir=None)
Re-implemented from JobApp; options and behavior is somewhat differnt.

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

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

Inherited from ui.qt.appframework2.af2.App: addMainTaskRunner, createInputSelector, currentTaskRunner, getWorkspaceStructure, processSettings, processTaskMessage, resetAllRunners, resizeEvent, setCurrentTask, setupTaskRunner, showEvent, showProgressBarForJob

Inherited from ui.qt.appframework2.af2.App (private): _applySettingsFromGroup, _close, _getSettingsForGroup, _help, _prestart, _prewrite, _read, _reset, _statusShrunk, _updateProgressBar

Inherited from ui.qt.appframework2.maestro_callback.AbstractMaestroCallbackMixin: buildCallbackDicts, ignoreMaestroCallbacks

Inherited from ui.qt.appframework2.maestro_callback.AbstractMaestroCallbackMixin (private): _addCallbacks, _closeEvent, _delayedCallbacks, _removeCallbacks, _showEvent

Inherited from ui.qt.appframework2.markers.MarkerMixin: addJaguarMarker, addMarker, addMarkerFromAsl, getAllJaguarMarkers, getAllMarkers, getJaguarMarker, hideAllJaguarMarkers, hideAllMarkers, hideEvent, removeAllJaguarMarkers, removeAllJaguarMarkersForEntry, removeAllMarkers, removeJaguarMarker, removeJaguarMarkerForAtoms, removeMarker, show, showAllJaguarMarkers, showAllMarkers

Inherited from ui.qt.appframework2.markers.MarkerMixin (private): _calcEntryAtomTotal, _canonicalizeAtomOrder, _clearInvalidatedJaguarMarkers, _createAtomAsl, _createJaguarMarker, _createMarker, _eidsFromHashable, _genMarkerHash, _hideAll, _setMarkerHash, _showAll, _updateMarkers

Inherited from ui.qt.appframework2.settings.SettingsPanelMixin: definePanelSettings, getPanelState, loadPanelState, setPanelState, writePanelState

Inherited from ui.qt.appframework2.settings.SettingsPanelMixin (private): _configurePanelSettings

Inherited from ui.qt.appframework2.settings.SettingsMixin: __getitem__, __setitem__, applyAliasedSettings, applySettings, getAliasedSettings, getAliasedValue, getObjValue, getPersistenceKey, getSettings, loadPersistentOptions, savePersistentOptions, setAlias, setAliasedValue, setAliases, setObjValue, setPersistent

Inherited from ui.qt.appframework2.baseapp.ValidatedPanel: reportValidation

Inherited from ui.qt.appframework2.baseapp.BasePanel: __str__, error, gui_closed, info, keyPressEvent, parent, question, restoreCursor, run, runCanvas, runMode, runStandalone, runSubpanel, setWaitCursor, startUp, warning

Inherited from ui.qt.appframework2.baseapp.BasePanel (private): _dockPrefChanged, _layOutDockWidget

Inherited from PyQt5.QtWidgets.QWidget: acceptDrops, accessibleDescription, accessibleName, actionEvent, actions, activateWindow, addAction, addActions, adjustSize, autoFillBackground, backgroundRole, baseSize, changeEvent, childAt, childrenRect, childrenRegion, clearFocus, clearMask, close, contentsMargins, contentsRect, contextMenuEvent, contextMenuPolicy, create, createWindowContainer, cursor, customContextMenuRequested, destroy, devType, dragEnterEvent, dragLeaveEvent, dragMoveEvent, dropEvent, effectiveWinId, ensurePolished, enterEvent, event, find, focusInEvent, focusNextChild, focusNextPrevChild, focusOutEvent, focusPolicy, focusPreviousChild, focusProxy, focusWidget, font, fontInfo, fontMetrics, foregroundRole, frameGeometry, frameSize, geometry, getContentsMargins, grab, grabGesture, grabKeyboard, grabMouse, grabShortcut, graphicsEffect, graphicsProxyWidget, hasFocus, hasHeightForWidth, hasMouseTracking, height, heightForWidth, hide, initPainter, inputMethodEvent, inputMethodHints, inputMethodQuery, insertAction, insertActions, isActiveWindow, isAncestorOf, isEnabled, isEnabledTo, isFullScreen, isHidden, isLeftToRight, isMaximized, isMinimized, isModal, isRightToLeft, isVisible, isVisibleTo, isWindow, isWindowModified, keyReleaseEvent, keyboardGrabber, layout, layoutDirection, leaveEvent, locale, lower, mapFrom, mapFromGlobal, mapFromParent, mapTo, mapToGlobal, mapToParent, mask, maximumHeight, maximumSize, maximumWidth, metric, minimumHeight, minimumSize, minimumSizeHint, minimumWidth, mouseDoubleClickEvent, mouseGrabber, mouseMoveEvent, mousePressEvent, mouseReleaseEvent, move, moveEvent, nativeEvent, nativeParentWidget, nextInFocusChain, normalGeometry, overrideWindowFlags, overrideWindowState, paintEngine, paintEvent, palette, parentWidget, pos, previousInFocusChain, raise_, rect, releaseKeyboard, releaseMouse, releaseShortcut, removeAction, render, repaint, resize, restoreGeometry, saveGeometry, scroll, setAcceptDrops, setAccessibleDescription, setAccessibleName, setAttribute, setAutoFillBackground, setBackgroundRole, setBaseSize, setContentsMargins, setContextMenuPolicy, setCursor, setDisabled, setEnabled, setFixedHeight, setFixedSize, setFixedWidth, setFocus, setFocusPolicy, setFocusProxy, setFont, setForegroundRole, setGeometry, setGraphicsEffect, setHidden, setInputMethodHints, setLayout, setLayoutDirection, setLocale, setMask, setMaximumHeight, setMaximumSize, setMaximumWidth, setMinimumHeight, setMinimumSize, setMinimumWidth, setMouseTracking, setPalette, setParent, setShortcutAutoRepeat, setShortcutEnabled, setSizeIncrement, setSizePolicy, setStatusTip, setStyle, setStyleSheet, setTabOrder, setToolTip, setToolTipDuration, setUpdatesEnabled, setVisible, setWhatsThis, setWindowFilePath, setWindowFlags, setWindowIcon, setWindowIconText, setWindowModality, setWindowModified, setWindowOpacity, setWindowRole, setWindowState, setWindowTitle, sharedPainter, showFullScreen, showMaximized, showMinimized, showNormal, size, sizeHint, sizeIncrement, sizePolicy, stackUnder, statusTip, style, styleSheet, tabletEvent, testAttribute, toolTip, toolTipDuration, underMouse, ungrabGesture, unsetCursor, unsetLayoutDirection, unsetLocale, update, updateGeometry, updateMicroFocus, updatesEnabled, visibleRegion, whatsThis, wheelEvent, width, winId, window, windowFilePath, windowFlags, windowHandle, windowIcon, windowIconChanged, windowIconText, windowIconTextChanged, windowModality, windowOpacity, windowRole, windowState, windowTitle, windowTitleChanged, windowType, x, y

Inherited from PyQt5.QtCore.QObject: __getattr__, blockSignals, childEvent, children, connectNotify, customEvent, deleteLater, destroyed, disconnect, disconnectNotify, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, eventFilter, findChild, findChildren, inherits, installEventFilter, isSignalConnected, isWidgetType, isWindowType, killTimer, metaObject, moveToThread, objectName, objectNameChanged, property, pyqtConfigure, receivers, removeEventFilter, sender, senderSignalIndex, setObjectName, setProperty, signalsBlocked, startTimer, thread, timerEvent, tr

Inherited from PyQt5.QtGui.QPaintDevice: colorCount, depth, devicePixelRatio, devicePixelRatioF, devicePixelRatioFScale, heightMM, logicalDpiX, logicalDpiY, paintingActive, physicalDpiX, physicalDpiY, widthMM

Inherited from sip.simplewrapper: __new__

Inherited from ui.qt.appframework2.validation.ValidationMixin: runValidation

Inherited from ui.qt.appframework2.validation.ValidationMixin (private): _validate, _validateChildren

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

Class Methods

[hide private]

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

Class Variables

[hide private]

Inherited from ui.qt.appframework2.af2.JobApp: NO_PROGRESS_BAR, PROGRESS_BAR_NO_TEXT, PROGRESS_BAR_WITH_TEXT

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

Inherited from PyQt5.QtWidgets.QWidget: DrawChildren, DrawWindowBackground, IgnoreMask

Inherited from PyQt5.QtCore.QObject: staticMetaObject

Inherited from PyQt5.QtGui.QPaintDevice: PdmDepth, PdmDevicePixelRatio, PdmDevicePixelRatioScaled, PdmDpiX, PdmDpiY, PdmHeight, PdmHeightMM, PdmNumColors, PdmPhysicalDpiX, PdmPhysicalDpiY, PdmWidth, PdmWidthMM

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, _multi_atom_markers

Properties

[hide private]

Inherited from ui.qt.appframework2.baseapp.BasePanel: title

Inherited from object: __class__

Method Details

[hide private]

_startOrWrite(self)

Over-riden method from JobApp class. Launcher/writes single or multiple jobs. The value of self.start_mode determines which to do.

Returns: False or None: Returns False upon failure, otherwise returns nothing (None)
Overrides: ui.qt.appframework2.af2.JobApp._startOrWrite

validateJobCount(self)

Decorators:

@af2.validator(-1000)

_preLaunchValidate(self)

Run validation before starting/writing jobs.

Returns: bool: True if validation passed, False if operation should be cancelled.

getJobCount(self)

Over-ride in the subclass to return the number of jobs that the user would like to start. Used for validation.

@return the number of jobs that the user requests.

Returns: int

multiJobStart(self)


Custom "start" method. For each job, creates a job sub-directory,
cd's into it, and launches the job there.

@return list of return values from self.launchFromJobSpec() calls.
    Each value is a Job object or False, in start mode, or True/False
    in write mode.

Decorators:

@af2.appmethods.start()

launchFromJobSpec(self, sub_jobname, job_num, oplsdir=None)

Re-implemented from JobApp; options and behavior is somewhat differnt.

Starts or write the command for the given subjob.

Returns:: Job object on successful start; True on successful write, False on failure.
Overrides: ui.qt.appframework2.af2.JobApp.launchFromJobSpec