schrodinger.application.desmond.guide module¶

A primitive workflow widget called Guide.

class schrodinger.application.desmond.guide.Guide(master, step=[], sep_pos='top')¶

This class provides a primitive workflow widget.

An object of this class has two public attributes:

curr_step : Points to the ‘_Step’ object of the current step.
step : A dictionary with keys to be the names of the steps and

values to be ‘_Step’ objects.

add_step(step)¶

Adds a step to the end of the guide widget.

Parameters:	step – Can be either a string or a tuple of two strings. If it is a string, this string will be used as both the name of the step in the code and the text displayed for the button; if it is a tuple, the first string will be the name of the step in the code, and the 2nd string will be the text displayed for the button.

enable_next(should_enable=True)¶: Enables the next step. If ‘should_enable’ is False, then it will disable the next step.

reset()¶

Resets the guide widget to its original state.

Normally, the original state is this: the first step is enabled but not yet entered, and the other steps are in the disabled state.

step_config(step, **kw)¶: Configures a few steps. :param step: Must be a list of _Step objects or the constant

‘ALL’.

step_hide(step, should_hide=True)¶: Hides a few steps as given by the ‘step’ argument, which is a list of _Step objects. If ‘should_hide’ is True, then reveal these steps.