pywatershed.ControlVariables#

class pywatershed.ControlVariables(control_dict)[source]#

PRMS control file class

Methods

`__init__`(control_dict)
`get_variables`(keys)	Get a subset of keys in the control variable dictionary
`load`(control_file)	Load variables from a PRMS control file

get_variables(keys)[source]#

Get a subset of keys in the control variable dictionary

Parameters:

keys (Union[str, list, tuple]) – keys to retrieve from the full PRMS control variable object

Return type:

ControlVariables

Returns:

ControlVariables –

subset of full control variable dictionary: Passed keys that do not exist in the full control variable dictionary are skipped.

static load(control_file)[source]#

Load variables from a PRMS control file

Parameters:: control_file (Union[str, PosixPath, dict]) – control file path
Return type:: ControlVariables
Returns:: ControlVariables – full PRMS control variable dictionary

pywatershed.ControlVariables