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__
def test_write_read_file(self):
""" Write and read excel file"""
act_1 = Measure()
act_1.name = 'Mangrove'
act_1.haz_type = 'TC'
act_1.color_rgb = np.array([1, 1, 1])
act_1.cost = 10
act_1.mdd_impact = (1, 2)
act_1.paa_impact = (1, 2)
act_1.hazard_inten_imp = (1, 2)
act_1.risk_transf_cover = 500
act_11 = Measure()
act_11.name = 'Something'
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_11.exp_region_id = 2
act_2 = Measure()
act_2.name = 'Anything'
act_2.haz_type = 'FL'
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)
act_2.hazard_freq_cutoff = 30
act_2.imp_fun_map = 'map'
meas_set = MeasureSet()
meas_set.append(act_1)
meas_set.append(act_11)
meas_set.append(act_2)
file_name = os.path.join(DATA_DIR, 'test_meas.xlsx')
meas_set.write_excel(file_name)
meas_read = MeasureSet()
meas_read.read_excel(file_name, 'test')
self.assertEqual(meas_read.tag.file_name, file_name)
self.assertEqual(meas_read.tag.description, 'test')
meas_list = meas_read.get_measure('TC')
meas_list.extend(meas_read.get_measure('FL'))
for meas in meas_list:
if meas.name == 'Mangrove':
meas_ref = act_1
elif meas.name == 'Something':
meas_ref = act_11
elif meas.name == 'Anything':
meas_ref = act_2
self.assertEqual(meas_ref.name, meas.name)
self.assertEqual(meas_ref.haz_type, meas.haz_type)
self.assertEqual(meas_ref.cost, meas.cost)
self.assertEqual(meas_ref.hazard_set, meas.hazard_set)
self.assertEqual(meas_ref.hazard_freq_cutoff,
meas.hazard_freq_cutoff)
self.assertEqual(meas_ref.exposures_set, meas.exposures_set)
self.assertEqual(meas_ref.exp_region_id, meas.exp_region_id)
self.assertTrue(np.array_equal(meas_ref.color_rgb, meas.color_rgb))
self.assertEqual(meas_ref.mdd_impact, meas.mdd_impact)
self.assertEqual(meas_ref.paa_impact, meas.paa_impact)
self.assertEqual(meas_ref.hazard_inten_imp, meas.hazard_inten_imp)
self.assertEqual(meas_ref.imp_fun_map, meas.imp_fun_map)
self.assertEqual(meas_ref.risk_transf_attach,
meas.risk_transf_attach)
self.assertEqual(meas_ref.risk_transf_cover,
meas.risk_transf_cover)
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__
