climada.entity package

• climada.entity.disc_rates package
  • climada.entity.disc_rates.base module
• climada.entity.exposures package
  • climada.entity.exposures.litpop package
    • climada.entity.exposures.litpop.gpw_population module
    • climada.entity.exposures.litpop.litpop module
    • climada.entity.exposures.litpop.nightlight module
  • climada.entity.exposures.base module
• climada.entity.impact_funcs package
  • climada.entity.impact_funcs.base module
  • climada.entity.impact_funcs.impact_func_set module
  • climada.entity.impact_funcs.storm_europe module
  • climada.entity.impact_funcs.trop_cyclone module
• climada.entity.measures package
  • climada.entity.measures.base module
  • climada.entity.measures.measure_set module

climada.entity.entity_def module

class climada.entity.entity_def.Entity(exposures=None, disc_rates=None, impact_func_set=None, measure_set=None)

Bases: object

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

exposures

exposures

Type

Exposures

impact_funcs

impact functions

Type

ImpactFucs

measures

measures

Type

MeasureSet

disc_rates

discount rates

Type

DiscRates

def_file

Default file from configuration file

Type

str

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

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

Return type

climada.entity.Entity

read_mat(*args, **kwargs)

This function is deprecated, use Entity.from_mat instead.

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

Return type

climada.entity.Entity

read_excel(*args, **kwargs)

This function is deprecated, use Entity.from_excel instead.

write_excel(file_name)

Write excel file following template.

check()

Check instance attributes.

Raises

ValueError –

climada.entity.tag module

class climada.entity.tag.Tag(file_name='', description='')

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='', description='')

Initialize values.

Parameters

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

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

append(tag)

Append input Tag instance information to current Tag.