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_pass(self):
"""Write + read excel file"""
imp_funcs = ImpactFuncSet()
imp_funcs.tag.file_name = 'No file name'
imp_funcs.tag.description = 'test writer'
imp1 = ImpactFunc()
imp1.id = 1
imp1.name = 'code 1'
imp1.intensity_unit = 'm/s'
imp1.haz_type = 'TC'
imp1.intensity = np.arange(100)
imp1.mdd = np.arange(100) * 0.5
imp1.paa = np.ones(100)
imp_funcs.append(imp1)
imp2 = ImpactFunc()
imp2.id = 2
imp2.name = 'code 2'
imp2.intensity_unit = 'm/s'
imp2.haz_type = 'TC'
imp2.intensity = np.arange(102)
imp2.mdd = np.arange(102) * 0.25
imp2.paa = np.ones(102)
imp_funcs.append(imp2)
imp3 = ImpactFunc()
imp3.id = 1
imp3.name = 'code 1'
imp3.intensity_unit = 'm'
imp3.haz_type = 'FL'
imp3.intensity = np.arange(86)
imp3.mdd = np.arange(86) * 0.15
imp3.paa = np.ones(86)
imp_funcs.append(imp3)
imp4 = ImpactFunc()
imp4.id = 15
imp4.name = 'code 15'
imp4.intensity_unit = 'K'
imp4.haz_type = 'DR'
imp4.intensity = np.arange(5)
imp4.mdd = np.arange(5)
imp4.paa = np.ones(5)
imp_funcs.append(imp4)
file_name = CONFIG.impact_funcs.test_data.dir().joinpath(
'test_write.xlsx')
imp_funcs.write_excel(file_name)
imp_res = ImpactFuncSet.from_excel(file_name)
self.assertEqual(imp_res.tag.file_name, str(file_name))
self.assertEqual(imp_res.tag.description, '')
# first function
for fun_haz, fun_dict in imp_res.get_func().items():
for fun_id, fun in fun_dict.items():
if fun_haz == 'TC' and fun_id == 1:
ref_fun = imp1
elif fun_haz == 'TC' and fun_id == 2:
ref_fun = imp2
elif fun_haz == 'FL' and fun_id == 1:
ref_fun = imp3
elif fun_haz == 'DR' and fun_id == 15:
ref_fun = imp4
else:
self.assertEqual(1, 0)
self.assertEqual(ref_fun.haz_type, fun.haz_type)
self.assertEqual(ref_fun.id, fun.id)
self.assertEqual(ref_fun.name, fun.name)
self.assertEqual(ref_fun.intensity_unit, fun.intensity_unit)
self.assertTrue(np.allclose(ref_fun.intensity, fun.intensity))
self.assertTrue(np.allclose(ref_fun.mdd, fun.mdd))
self.assertTrue(np.allclose(ref_fun.paa, fun.paa))
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__
