schrodinger.application.jaguar.nics_predictor.input module¶

Functions and classes for defining the input to nics_predictor.py.

class schrodinger.application.jaguar.nics_predictor.input.NICSInput(inputfile: str | None = None, keywords: dict | None = None, jobname: str | None = None)¶

Bases: WorkflowInput

A class to completely specify a nics_predictor calculation.

Example usage:

input = NICSInput()
# 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 {keyword} has value {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 = 'nics_predictor'¶

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

Create a NICSInput instance. If a keyword is specified in both ‘inputfile’ and ‘keywords’, then the values in ‘keywords’ will be set preferrentially.

Parameters:

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

validate_jaguar_keywords()¶: We currently don’t use JaguarKeywords in this workflow so don’t allow any to be set.

validate()¶

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

:raise WorkflowKeywordConflictError if conflicting values found