schrodinger.ui.qt.appframework2.af2_template module

class schrodinger.ui.qt.appframework2.af2_template.AppTemplate(**kwargs)

Bases: schrodinger.ui.qt.appframework2.af2.JobApp

__init__(**kwargs)
Parameters
  • stop_before (int) – Exit the constructor before specified step.

  • parent (QWidget) – Parent widget, if any.

  • in_knime (bool) – Whether we are currently running under KNIME - a mode in which input selector is hidden, optionally a custom Workspace Structure is specified, and buttom bar has OK & Cancel buttons.

  • workspace_st_file (bool) – Structure to be returned by getWorkspaceStructure() when in_knime is True.

setPanelOptions()

See parent class for more options.

self.use_mini_jobbar - whether this panel use the narrow version of the bottom job bar. This is useful for narrow panels where the regular job bar is too wide to fit. Default: False

self.viewname - this identifier is used by the job status button so that it knows which jobs belong to this panel. This is automatically generated from the module and class name of the panel and so it does not need to be set unless the module/class names are generic.

self.program_name - a human-readable text name for the job this panel launches. This shows up in the main job monitor to help the user identify the job. Example: “Glide grid generation”. Default: “Job”

self.omit_one_from_standard_jobname - see documentation in jobnames.py

add_driverhost - If True, the backend supports running -DRIVERHOST to specify a different host for the driver job than subjobs. Only certain workflows support this option.

getConfigDialog()
setup()
setDefaults()
layOut()
defineCustomSettings()
startJob()
resetPanel()
closePanel()
onProjectChanged(proj)
onProjectClosed()
onWorkspaceChanged(what_changed)
onWorkspaceChangedWithActiveProj(what_changed, proj)
validatePanel()
class schrodinger.ui.qt.appframework2.af2_template.SettingsInJobNamesTemplate(**kwargs)

Bases: schrodinger.ui.qt.appframework2.af2.JobApp

This class includes panel settings in its job name

setPanelOptions()

See parent class for more options.

self.use_mini_jobbar - whether this panel use the narrow version of the bottom job bar. This is useful for narrow panels where the regular job bar is too wide to fit. Default: False

self.viewname - this identifier is used by the job status button so that it knows which jobs belong to this panel. This is automatically generated from the module and class name of the panel and so it does not need to be set unless the module/class names are generic.

self.program_name - a human-readable text name for the job this panel launches. This shows up in the main job monitor to help the user identify the job. Example: “Glide grid generation”. Default: “Job”

self.omit_one_from_standard_jobname - see documentation in jobnames.py

add_driverhost - If True, the backend supports running -DRIVERHOST to specify a different host for the driver job than subjobs. Only certain workflows support this option.

setup()

In setup, make sure that self.jobnameDataChanged is called every time the jobname needs to be updated

jobnameData()

Reimplement jobnameData to return the data to be interpolated into the job name