climada.entity package#

climada.entity.entity_def module#

class climada.entity.entity_def.Entity(exposures: Optional[climada.entity.exposures.base.Exposures] = None, disc_rates: Optional[climada.entity.disc_rates.base.DiscRates] = None, impact_func_set: Optional[climada.entity.impact_funcs.impact_func_set.ImpactFuncSet] = None, measure_set: Optional[climada.entity.measures.measure_set.MeasureSet] = None)[source]#

Bases: object

Collects exposures, impact functions, measures and discount rates. Default values set when empty constructor.

exposures#

exposures

Type

Exposures

impact_funcs#

impact functions set

Type

ImpactFuncSet

measures#

measures

Type

MeasureSet

disc_rates#

discount rates

Type

DiscRates

def_file#

Default file from configuration file

Type

str

__init__(exposures: Optional[climada.entity.exposures.base.Exposures] = None, disc_rates: Optional[climada.entity.disc_rates.base.DiscRates] = None, impact_func_set: Optional[climada.entity.impact_funcs.impact_func_set.ImpactFuncSet] = None, measure_set: Optional[climada.entity.measures.measure_set.MeasureSet] = None)[source]#

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().

classmethod from_mat(file_name, description='')[source]#

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 – The entity from matlab file

Return type

climada.entity.Entity

read_mat(*args, **kwargs)[source]#

This function is deprecated, use Entity.from_mat instead.

classmethod from_excel(file_name, description='')[source]#

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 – The entity from excel file

Return type

climada.entity.Entity

read_excel(*args, **kwargs)[source]#

This function is deprecated, use Entity.from_excel instead.

write_excel(file_name)[source]#

Write excel file following template.

check()[source]#

Check instance attributes.

Raises

ValueError –

climada.entity.tag module#

class climada.entity.tag.Tag(file_name: str = '', description: str = '')[source]#

Bases: object

Source data tag for Exposures, DiscRates, ImpactFuncSet, MeasureSet.

file_name#

name of the source file

Type

str

description#

description of the data

Type

str

__init__(file_name: str = '', description: str = '')[source]#

Initialize values.

Parameters

  • file_name (str, optional) – file name to read

  • description (str, optional) – description of the data

append(tag)[source]#

Append input Tag instance information to current Tag.