climada.entity package

climada.entity.entity_def module

class climada.entity.entity_def.Entity[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

Type

ImpactFucs

measures

measures

Type

MeasureSet

disc_rates

discount rates

Type

DiscRates

def_file

Default file from configuration file

Type

str

__init__()[source]

Empty initializator

read_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

Raises

ValueError

read_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

Raises

ValueError

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