schrodinger.application.jaguar.ames.ames_input module¶

Functions and classes for defining the input to the AMES workflow.

class schrodinger.application.jaguar.ames.ames_input.AMESInput(inputfile: str | None = None, keywords: dict | None = None, jaguar_keywords: dict | None = None, jobname: str | None = None)¶

Bases: WorkflowInput

A class to completely specify an AMES calculation.

Example usage:

input = AMESInput()
# Set user-defined values
input.setValue('integerKW', 3)
input.setValue('floatKW', '7.0')
input.setValue('stringKW', 'foo')

# Print all keyword/value pairs.
for keyword in input:
    print "keyword '%s' has value %s" % (keyword, input[keyword])

# Handling the case of trying to set an unsupported keyword
try:
    input['mykeyword'] = 'value'
except WorkflowKeywordException as e:
    print e.allowed_keywords

input_file_keys = ['infile']¶

keyword_source = {}¶

static keyword_generator()¶

Function to generate the keyword source dictionary. This is used to initialize the keyword_source property.

Returns:: None

workflow_name = 'AMES Workflow'¶

__init__(inputfile: str | None = None, keywords: dict | None = None, jaguar_keywords: dict | None = None, jobname: str | None = None)¶

Create a AMESInput instance. If a keyword is specified in both ‘inputfile’ and ‘keywords’, then the values in ‘keywords’ will be set preferentially. This also applies to ‘jaguar_keywords’.

Parameters:

inputfile – Path to a AMES input file
keywords – AMES keyword/value pairs
jaguar_keywords – Jaguar &gen section keyword/value pairs
jobname – Name of job, if it is not None it will be set to the basename of the input file name.

setJaguarValues(keywords: dict)¶

Set multiple Jaguar &gen section keywords.

Parameters:: keywords – Jaguar &gen section keyword/value pairs

validate()¶

Perform a self-consistency check of all currently set keywords.

:raise WorkflowKeywordConflictError if conflicting values found :raise WorkflowConservationError if matter not conserved

read(inputfile: str)¶

Read an existing AMES input file. Any keywords specified in the input file will override existing values in this AMESInput instance.

Jaguar &gen section keywords are defined like:

&JaguarKeywords
  key=val
  key=val
  ...
&

Constraints can be defined with:

&Constraints
    st_title atom_index1 atom_index2... value
&

Parameters:: inputfile – Path to a AMES input file