schrodinger.application.matsci.appbase module

Module for customizing af2 app features

Copyright Schrodinger, LLC. All rights reserved.

class schrodinger.application.matsci.appbase.MatSciAppMixin[source]

Bases: object

General mixin for MatSci panels

WAM_LOAD_SELECTED = 'selected_entries'
WAM_LOAD_INCLUDED = 'included_entry'
initMixinOptions(wam_input_state=None, wam_load_function=None, wam_run_singleton=True, wam_set_panel_input_state=True)[source]

Initialize the options for the mixin

Parameters
  • wam_input_state (str) – The input state to use to get the WAM entries

  • wam_load_function (callable) – Function that takes no arguments and loads the entries into the panel.

  • wam_run_singleton (bool) – Whether the panel singleton should be run (i.e. displayed) or not.

  • wam_set_panel_input_state (bool) – Whether to set panel’s input_selector state to the corresponding wam_input_state

classmethod panel(*entry_ids)[source]

Launch a singleton instance of the panel and load entries if applicable. See af2.App.panel for more information.

Parameters

entry_ids (tuple) – Entry ids to load into the panel

Raises

RuntimeError – If the input state is invalid