def test_add_parameters(self, get_empty_sector_model):
sos_model = SosModel('global')
sos_model_param = {
'name': 'sos_model_param',
'description': 'A global parameter passed to all contained models',
'absolute_range': (0, 100),
'suggested_range': (3, 10),
'default_value': 3,
'units': '%'
}
sos_model.add_parameter(sos_model_param)
expected = sos_model_param
assert sos_model.parameters['sos_model_param'].as_dict() == expected
assert sos_model.parameters.names == ['sos_model_param']
sector_model = get_empty_sector_model('source_model')
sector_model.add_parameter({
'name': 'sector_model_param',
'description': 'Required for the sectormodel',
'absolute_range': (0, 100),
'suggested_range': (3, 10),
'default_value': 3,
'units': '%'
})
sos_model.add_model(sector_model)
# SosModel contains only its own parameters
assert 'sos_model_param' in sos_model.parameters.names
# SectorModel has its own ParameterList, gettable by param name
assert 'sector_model_param' in sector_model.parameters.names
def test_default_parameter_passing_(self, get_empty_sector_model):
"""Tests that default values for global parameters are passed to all
models, and others default values only passed into the intended models.
"""
sos_model_param = {
'name': 'sos_model_param',
'description': 'A global parameter passed to all contained models',
'absolute_range': (0, 100),
'suggested_range': (3, 10),
'default_value': 3,
'units': '%'
}
sos_model = SosModel('global')
sos_model.add_parameter(sos_model_param)
sector_model = get_empty_sector_model('source_model')
# Patch the sector model so that it returns the calling arguments
sector_model.simulate = lambda _, y: {'sm1': y}
sos_model.add_model(sector_model)
assert sos_model.simulate(2010) == {'sm1': {'sos_model_param': 3}}
sector_model.add_parameter({
'name': 'sector_model_param',
'description': 'Some meaningful text',
'absolute_range': (0, 100),
'suggested_range': (3, 10),
'default_value': 3,
'units': '%'
})
assert sos_model.simulate(2010) == {
'sm1': {
'sector_model_param': 3,
'sos_model_param': 3
}
}
sector_model_2 = get_empty_sector_model('another')
sector_model_2.simulate = lambda _, y: {'sm2': y}
sos_model.add_model(sector_model_2)
assert sos_model.simulate(2010) == {
'sm1': {
'sector_model_param': 3,
'sos_model_param': 3
},
'sm2': {
'sos_model_param': 3
}
}
def test_add_parameters(self, get_empty_sector_model):
sos_model_param = {
'name': 'sos_model_param',
'description': 'A global parameter passed to all contained models',
'absolute_range': (0, 100),
'suggested_range': (3, 10),
'default_value': 3,
'units': '%'
}
sos_model = SosModel('global')
sos_model.add_parameter(sos_model_param)
expected = dict(sos_model_param, **{'parent': sos_model})
assert sos_model.parameters == {
'global': {
'sos_model_param': expected
}
}
assert sos_model.parameters['global'].names == ['sos_model_param']
sector_model = get_empty_sector_model('source_model')
sector_model.add_parameter({
'name': 'sector_model_param',
'description': 'Required for the sectormodel',
'absolute_range': (0, 100),
'suggested_range': (3, 10),
'default_value': 3,
'units': '%'
})
sos_model.add_model(sector_model)
# SosModel contains ParameterList objects in a nested dict by model name
assert 'global' in sos_model.parameters
assert 'sos_model_param' in sos_model.parameters['global'].names
# SosModel parameter attribute holds references to contained
# model parameters keyed by model name
assert 'source_model' in sos_model.parameters
assert 'sector_model_param' in sos_model.parameters['source_model']
# SectorModel has a ParameterList, gettable by param name
assert 'sector_model_param' in sector_model.parameters.names
assert 'source_model' in sos_model.parameters
assert 'sector_model_param' in sos_model.parameters['source_model']
