Package schrodinger :: Package application :: Package jaguar :: Module reactiq_keyword_register
[hide private]
[frames] | no frames]

Module reactiq_keyword_register

This module documents all possible Reactiq input keywords, defined as key/value pairs.

The REACTIQ_KEYWORDS dictionary is initialized by the module function generate_all_keywords()

When new functionality is added to Reactiq, any new keywords should be added at the bottom of this file.

Functions [hide private]
 
keyword(name, valid_type, default, description, choices=[], subtype=None)
Convenience function to create a ReactiqKeyword instance.
 
generate_all_keywords()
Variables [hide private]
  REACTIQ_KEYWORDS = {}
  __package__ = 'schrodinger.application.jaguar'
Function Details [hide private]

keyword(name, valid_type, default, description, choices=[], subtype=None)

 

Convenience function to create a ReactiqKeyword instance.

Parameters:
  • name (string) - unique name for keyword
  • valid_type (python type) - keyword type e.g. bool, int
  • default (<valid_type>) - default keyword value
  • description (string) - short description of what the keyword does
  • choices (list of <valid_type>'s) - allowed values for the keyword value
  • subtype (python type) - if valid_type is list then this is type of list members