smif.parameters package

Submodules

smif.parameters.narrative module

Contains classes and methods relating to narratives.

Narrative hold collections of overridden parameter data. During model setup, a user compiles a number of narrative files which contains a list of parameter names and values. These are assigned to a narrative set during a model run and the Narrative object holds this information at runtime.

class smif.parameters.narrative.Narrative(name, description, narrative_set)

Bases: object

Holds information relating to parameters from a collection of narrative policies

Parameters:

• name (str) –
• description (str) –
• narrative_set (str) –

Example

>>> narrative = Narrative('Energy Demand - High Tech',
                              'A description',
                              'technology')

as_dict()

Serialise the narrative data

Returns:A dictionary of serialised narrative metadata:

{'name': 'a_name',
 'description': 'a description',
 'narrative_set': 'a_narrative_set'}

Return type:dict

data

The narrative data keyed by model name or global

Returns:A nested dictionary containing the narrative data:

{'global': [{'global_parameter': 'value'}],
 'model_name': [{'model_parameter': 'value'},
                {'model_parameter_two': 'value'}
                ]
}

Return type:dict

Module contents

class smif.parameters.ParameterList(**kwargs)

Bases: collections.UserDict

add_parameter(name, description, absolute_range, suggested_range, default_value, units, parent)

Add a parameter to the parameter list

Parameters:

• name (str) –
• description (str) –
• absolute_range (tuple) –
• suggested_range (tuple) –
• default_value (float) –
• units (str) –
• parent (smif.model.Model) –

add_parameters_from_list(config_list)

as_dict()

defaults

names

Returns the names of all the contained parameters

parameters