def test_check_name_fail(self):
"""Wrong measures definition"""
meas = MeasureSet()
act_1 = Measure()
act_1.name = 'LaLa'
act_1.haz_type = 'FL'
meas._data['FL'] = dict()
meas._data['FL']['LoLo'] = act_1
with self.assertRaises(ValueError) as cm:
meas.check()
self.assertIn('Wrong Measure.name: LoLo != LaLa', str(cm.exception))
def test_check_name_fail(self):
"""Wrong measures definition"""
meas = MeasureSet()
act_1 = Measure()
act_1.name = 'LaLa'
act_1.haz_type = 'FL'
meas._data['FL'] = dict()
meas._data['FL']['LoLo'] = act_1
with self.assertLogs('climada.entity.measures.measure_set', level='ERROR') as cm:
with self.assertRaises(ValueError):
meas.check()
self.assertIn('Wrong Measure.name: LoLo != LaLa', cm.output[0])
def test_check_wrongMDD_fail(self):
"""Wrong measures definition"""
meas = MeasureSet()
act_1 = Measure()
act_1.name = 'Mangrove'
act_1.haz_type = 'DR'
act_1.color_rgb = np.array([1, 1, 1])
act_1.mdd_impact = (1)
act_1.paa_impact = (1, 2)
act_1.hazard_inten_imp = (1, 2)
meas.append(act_1)
with self.assertRaises(ValueError) as cm:
meas.check()
self.assertIn('Measure.mdd_impact has wrong size.', str(cm.exception))
def test_check_wrongPAA_fail(self):
"""Wrong measures definition"""
meas = MeasureSet()
act_1 = Measure()
act_1.name = 'Mangrove'
act_1.haz_type = 'TC'
act_1.color_rgb = np.array([1, 1, 1])
act_1.mdd_impact = (1, 2)
act_1.paa_impact = (1, 2, 3, 4)
act_1.hazard_inten_imp = (1, 2)
meas.append(act_1)
with self.assertLogs('climada.util.checker', level='ERROR') as cm:
with self.assertRaises(ValueError):
meas.check()
self.assertIn('Invalid Measure.paa_impact size: 2 != 4.', cm.output[0])
def test_check_wrongColor_fail(self):
"""Wrong measures definition"""
meas = MeasureSet()
act_1 = Measure()
act_1.name = 'Mangrove'
act_1.haz_type = 'DR'
act_1.color_rgb = (1, 2)
act_1.mdd_impact = (1, 2)
act_1.paa_impact = (1, 2)
act_1.hazard_inten_imp = (1, 2)
meas.append(act_1)
with self.assertRaises(ValueError) as cm:
meas.check()
self.assertIn('Invalid Measure.color_rgb size: 2 not in [3, 4].',
str(cm.exception))
def test_check_wronginten_fail(self):
"""Wrong intensity definition"""
meas = MeasureSet()
act_1 = Measure()
act_1.haz_type = 'TC'
act_1.name = 'Mangrove'
act_1.hazard_inten_imp = (1, 2, 3)
act_1.color_rgb = np.array([1, 1, 1])
act_1.mdd_impact = (1, 2)
act_1.paa_impact = (1, 2)
meas.append(act_1)
with self.assertRaises(ValueError) as cm:
meas.check()
self.assertIn('Invalid Measure.hazard_inten_imp size: 2 != 3.',
str(cm.exception))
def test_def_color(self):
"""Test default grey scale used when no color set"""
meas = MeasureSet()
act_1 = Measure()
act_1.name = 'LaLa'
act_1.haz_type = 'FL'
meas.append(act_1)
act_2 = Measure()
act_2.name = 'LoLo'
act_2.haz_type = 'FL'
meas.append(act_2)
meas.check()
self.assertTrue(np.array_equal(meas.get_measure('FL', 'LaLa').color_rgb, np.ones(4)))
self.assertTrue(np.allclose(meas.get_measure('FL', 'LoLo').color_rgb,
np.array([0., 0., 0., 1.0])))
def test_extend_to_empty_same(self):
"""Extend MeasureSet to empty one."""
meas = MeasureSet()
meas_add = MeasureSet()
act_1 = Measure()
act_1.name = 'Mangrove'
act_1.haz_type = 'TC'
act_1.color_rgb = np.array([1, 1, 1])
act_1.mdd_impact = (1, 2)
act_1.paa_impact = (1, 2)
act_1.hazard_inten_imp = (1, 2)
meas_add.append(act_1)
meas.extend(meas_add)
meas.check()
self.assertEqual(meas.size(), 1)
self.assertEqual(meas.get_names(), {'TC': ['Mangrove']})
def test_extend_equal_same(self):
"""Extend the same MeasureSet. The inital MeasureSet is obtained."""
meas = MeasureSet()
meas_add = MeasureSet()
act_1 = Measure()
act_1.name = 'Mangrove'
act_1.haz_type = 'TC'
act_1.color_rgb = np.array([1, 1, 1])
act_1.mdd_impact = (1, 2)
act_1.paa_impact = (1, 2)
act_1.hazard_inten_imp = (1, 2)
meas.append(act_1)
meas_add.append(act_1)
meas.extend(meas_add)
meas.check()
self.assertEqual(meas.size(), 1)
self.assertEqual(meas.get_names(), {'TC': ['Mangrove']})
def test_extend_different_extend(self):
"""Extend MeasureSet with same and new values. The actions
with repeated name are overwritten."""
act_1 = Measure()
act_1.name = 'Mangrove'
act_1.haz_type = 'TC'
act_1.color_rgb = np.array([1, 1, 1])
act_1.mdd_impact = (1, 2)
act_1.paa_impact = (1, 2)
act_1.hazard_inten_imp = (1, 2)
act_11 = Measure()
act_11.name = 'Mangrove'
act_11.haz_type = 'TC'
act_11.color_rgb = np.array([1, 1, 1])
act_11.mdd_impact = (1, 2)
act_11.paa_impact = (1, 3)
act_11.hazard_inten_imp = (1, 2)
act_2 = Measure()
act_2.name = 'Anything'
act_2.haz_type = 'TC'
act_2.color_rgb = np.array([1, 1, 1])
act_2.mdd_impact = (1, 2)
act_2.paa_impact = (1, 2)
act_2.hazard_inten_imp = (1, 2)
meas = MeasureSet()
meas.append(act_1)
meas_add = MeasureSet()
meas_add.append(act_11)
meas_add.append(act_2)
meas.extend(meas_add)
meas.check()
self.assertEqual(meas.size(), 2)
self.assertEqual(meas.get_names(), {'TC': ['Mangrove', 'Anything']})
self.assertEqual(
meas.get_measure(name=act_1.name)[0].paa_impact, act_11.paa_impact)
class Entity(object):
"""Collects exposures, impact functions, measures and discount rates.
Default values set when empty constructor.
Attributes:
exposures (Exposures): exposures
impact_funcs (ImpactFucs): impact functions
measures (MeasureSet): measures
disc_rates (DiscRates): discount rates
def_file (str): Default file from configuration file
"""
def __init__(self):
""" Empty initializator """
self.exposures = Exposures()
self.disc_rates = DiscRates()
self.impact_funcs = ImpactFuncSet()
self.measures = MeasureSet()
def read_mat(self, file_name, description=''):
"""Read MATLAB file of climada.
Parameters:
file_name (str, optional): file name(s) or folder name
containing the files to read
description (str or list(str), optional): one description of the
data or a description of each data file
Raises:
ValueError
"""
self.exposures = Exposures()
self.exposures.read_mat(file_name)
self.disc_rates = DiscRates()
self.disc_rates.read_mat(file_name, description)
self.impact_funcs = ImpactFuncSet()
self.impact_funcs.read_mat(file_name, description)
self.measures = MeasureSet()
self.measures.read_mat(file_name, description)
def read_excel(self, file_name, description=''):
"""Read csv or xls or xlsx file following climada's template.
Parameters:
file_name (str, optional): file name(s) or folder name
containing the files to read
description (str or list(str), optional): one description of the
data or a description of each data file
Raises:
ValueError
"""
self.exposures = Exposures(pd.read_excel(file_name))
self.exposures.tag = Tag()
self.exposures.tag.file_name = file_name
self.exposures.tag.description = description
self.disc_rates = DiscRates()
self.disc_rates.read_excel(file_name, description)
self.impact_funcs = ImpactFuncSet()
self.impact_funcs.read_excel(file_name, description)
self.measures = MeasureSet()
self.measures.read_excel(file_name, description)
def write_excel(self, file_name):
""" Write excel file following template. """
self.exposures.to_excel(file_name)
self.impact_funcs.write_excel(file_name)
self.measures.write_excel(file_name)
self.disc_rates.write_excel(file_name)
def check(self):
"""Check instance attributes.
Raises:
ValueError
"""
self.disc_rates.check()
self.exposures.check()
self.impact_funcs.check()
self.measures.check()
def __setattr__(self, name, value):
"""Check input type before set"""
if name == "exposures":
if not isinstance(value, Exposures):
LOGGER.error("Input value is not (sub)class of Exposures.")
raise ValueError
elif name == "impact_funcs":
if not isinstance(value, ImpactFuncSet):
LOGGER.error("Input value is not (sub)class of ImpactFuncSet.")
raise ValueError
elif name == "measures":
if not isinstance(value, MeasureSet):
LOGGER.error("Input value is not (sub)class of MeasureSet.")
raise ValueError
elif name == "disc_rates":
if not isinstance(value, DiscRates):
LOGGER.error("Input value is not (sub)class of DiscRates.")
raise ValueError
super().__setattr__(name, value)
def __str__(self):
return 'Exposures: \n' + self.exposures.tag.__str__() + \
'\nDiscRates: \n' + self.disc_rates.tag.__str__() + \
'\nImpactFuncSet: \n' + self.impact_funcs.tag.__str__() + \
'\nMeasureSet: \n' + self.measures.tag.__str__()
__repr__ = __str__
class Entity(object):
"""Collects exposures, impact functions, measures and discount rates.
Default values set when empty constructor.
Attributes
----------
exposures : Exposures
exposures
impact_funcs : ImpactFucs
impact functions
measures : MeasureSet
measures
disc_rates : DiscRates
discount rates
def_file : str
Default file from configuration file
"""
def __init__(self,
exposures=None,
disc_rates=None,
impact_func_set=None,
measure_set=None):
"""
Initialize entity
Parameters
----------
exposures : climada.entity.Exposures, optional
Exposures of the entity. The default is None (empty Exposures()).
disc_rates : climada.entity.DiscRates, optional
Disc rates of the entity. The default is None (empty DiscRates()).
impact_func_set : climada.entity.ImpactFuncSet, optional
The impact function set. The default is None (empty ImpactFuncSet()).
measure_set : climada.entity.Measures, optional
The measures. The default is None (empty MeasuresSet().
"""
self.exposures = Exposures() if exposures is None else exposures
self.disc_rates = DiscRates() if disc_rates is None else disc_rates
self.impact_funcs = ImpactFuncSet(
) if impact_func_set is None else impact_func_set
self.measures = MeasureSet() if measure_set is None else measure_set
@classmethod
def from_mat(cls, file_name, description=''):
"""Read MATLAB file of climada.
Parameters
----------
file_name : str, optional
file name(s) or folder name
containing the files to read
description : str or list(str), optional
one description of the
data or a description of each data file
Returns
-------
ent : climada.entity.Entity
The entity from matlab file
"""
return cls(exposures=Exposures.from_mat(file_name),
disc_rates=DiscRates.from_mat(file_name, description),
impact_func_set=ImpactFuncSet.from_mat(
file_name, description),
measure_set=MeasureSet.from_mat(file_name, description))
def read_mat(self, *args, **kwargs):
"""This function is deprecated, use Entity.from_mat instead."""
LOGGER.warning("The use of Entity.read_mat is deprecated."
"Use Entity.from_mat instead.")
self.__dict__ = Entity.from_mat(*args, **kwargs).__dict__
@classmethod
def from_excel(cls, file_name, description=''):
"""Read csv or xls or xlsx file following climada's template.
Parameters
----------
file_name : str, optional
file name(s) or folder name
containing the files to read
description : str or list(str), optional
one description of the
data or a description of each data file
Returns
-------
ent : climada.entity.Entity
The entity from excel file
"""
exp = Exposures(pd.read_excel(file_name))
exp.tag = Tag()
exp.tag.file_name = str(file_name)
exp.tag.description = description
dr = DiscRates.from_excel(file_name, description)
impf_set = ImpactFuncSet.from_excel(file_name, description)
meas_set = MeasureSet.from_excel(file_name, description)
return cls(exposures=exp,
disc_rates=dr,
impact_func_set=impf_set,
measure_set=meas_set)
def read_excel(self, *args, **kwargs):
"""This function is deprecated, use Entity.from_excel instead."""
LOGGER.warning("The use of Entity.read_excel is deprecated."
"Use Entity.from_excel instead.")
self.__dict__ = Entity.from_excel(*args, **kwargs).__dict__
def write_excel(self, file_name):
"""Write excel file following template."""
self.exposures.gdf.to_excel(file_name)
self.impact_funcs.write_excel(file_name)
self.measures.write_excel(file_name)
self.disc_rates.write_excel(file_name)
def check(self):
"""Check instance attributes.
Raises
------
ValueError
"""
self.disc_rates.check()
self.exposures.check()
self.impact_funcs.check()
self.measures.check()
def __setattr__(self, name, value):
"""Check input type before set"""
if name == "exposures":
if not isinstance(value, Exposures):
raise ValueError("Input value is not (sub)class of Exposures.")
elif name == "impact_funcs":
if not isinstance(value, ImpactFuncSet):
raise ValueError(
"Input value is not (sub)class of ImpactFuncSet.")
elif name == "measures":
if not isinstance(value, MeasureSet):
raise ValueError(
"Input value is not (sub)class of MeasureSet.")
elif name == "disc_rates":
if not isinstance(value, DiscRates):
raise ValueError("Input value is not (sub)class of DiscRates.")
super().__setattr__(name, value)
def __str__(self):
return 'Exposures: \n' + self.exposures.tag.__str__() + \
'\nDiscRates: \n' + self.disc_rates.tag.__str__() + \
'\nImpactFuncSet: \n' + self.impact_funcs.tag.__str__() + \
'\nMeasureSet: \n' + self.measures.tag.__str__()
__repr__ = __str__
