climada.entity package

• climada.entity.disc_rates package
  • climada.entity.disc_rates.base module
    • DiscRates
      • DiscRates.years
      • DiscRates.rates
      • DiscRates.__init__()
      • DiscRates.clear()
      • DiscRates.check()
      • DiscRates.select()
      • DiscRates.append()
      • DiscRates.net_present_value()
      • DiscRates.plot()
      • DiscRates.from_mat()
      • DiscRates.read_mat()
      • DiscRates.from_excel()
      • DiscRates.read_excel()
      • DiscRates.write_excel()
      • DiscRates.from_csv()
      • DiscRates.write_csv()
• climada.entity.exposures package
  • climada.entity.exposures.litpop package
    • climada.entity.exposures.litpop.gpw_population module
      • load_gpw_pop_shape()
      • get_gpw_file_path()
      • grid_aligned_with_gpw()
    • climada.entity.exposures.litpop.litpop module
      • GPW_VERSION
      • LitPop
        • LitPop.exponents
        • LitPop.fin_mode
        • LitPop.gpw_version
        • LitPop.__init__()
        • LitPop.set_countries()
        • LitPop.from_countries()
        • LitPop.set_nightlight_intensity()
        • LitPop.from_nightlight_intensity()
        • LitPop.set_population()
        • LitPop.from_population()
        • LitPop.set_custom_shape_from_countries()
        • LitPop.from_shape_and_countries()
        • LitPop.set_custom_shape()
        • LitPop.from_shape()
        • LitPop.set_country()
      • get_value_unit()
      • reproject_input_data()
      • gridpoints_core_calc()
    • climada.entity.exposures.litpop.nightlight module
      • NOAA_RESOLUTION_DEG
      • NASA_RESOLUTION_DEG
      • NASA_TILE_SIZE
      • NOAA_BORDER
      • BM_FILENAMES
      • BM_NIGHTLIGHT_GRID
      • load_nasa_nl_shape()
      • get_required_nl_files()
      • check_nl_local_file_exists()
      • download_nl_files()
      • load_nasa_nl_shape_single_tile()
      • load_nightlight_nasa()
      • read_bm_file()
      • unzip_tif_to_py()
      • untar_noaa_stable_nightlight()
      • load_nightlight_noaa()
  • climada.entity.exposures.base module
    • Exposures
      • Exposures.description
      • Exposures.ref_year
      • Exposures.value_unit
      • Exposures.data
      • Exposures.vars_oblig
      • Exposures.vars_def
      • Exposures.vars_opt
      • Exposures.crs
      • Exposures.gdf
      • Exposures.latitude
      • Exposures.longitude
      • Exposures.geometry
      • Exposures.value
      • Exposures.region_id
      • Exposures.category_id
      • Exposures.cover
      • Exposures.deductible
      • Exposures.hazard_impf()
      • Exposures.hazard_centroids()
      • Exposures.derive_raster()
      • Exposures.__init__()
      • Exposures.check()
      • Exposures.set_crs()
      • Exposures.set_gdf()
      • Exposures.get_impf_column()
      • Exposures.assign_centroids()
      • Exposures.set_geometry_points()
      • Exposures.set_lat_lon()
      • Exposures.set_from_raster()
      • Exposures.from_raster()
      • Exposures.plot_scatter()
      • Exposures.plot_hexbin()
      • Exposures.plot_raster()
      • Exposures.plot_basemap()
      • Exposures.write_hdf5()
      • Exposures.read_hdf5()
      • Exposures.from_hdf5()
      • Exposures.read_mat()
      • Exposures.from_mat()
      • Exposures.to_crs()
      • Exposures.plot()
      • Exposures.copy()
      • Exposures.write_raster()
      • Exposures.concat()
      • Exposures.centroids_total_value()
      • Exposures.affected_total_value()
    • add_sea()
    • INDICATOR_IMPF
    • INDICATOR_CENTR
• climada.entity.impact_funcs package
  • climada.entity.impact_funcs.base module
    • ImpactFunc
      • ImpactFunc.haz_type
      • ImpactFunc.id
      • ImpactFunc.name
      • ImpactFunc.intensity_unit
      • ImpactFunc.intensity
      • ImpactFunc.mdd
      • ImpactFunc.paa
      • ImpactFunc.__init__()
      • ImpactFunc.calc_mdr()
      • ImpactFunc.plot()
      • ImpactFunc.check()
      • ImpactFunc.from_step_impf()
      • ImpactFunc.set_step_impf()
      • ImpactFunc.from_sigmoid_impf()
      • ImpactFunc.set_sigmoid_impf()
      • ImpactFunc.from_poly_s_shape()
  • climada.entity.impact_funcs.impact_func_set module
    • ImpactFuncSet
      • ImpactFuncSet._data
      • ImpactFuncSet.__init__()
      • ImpactFuncSet.clear()
      • ImpactFuncSet.append()
      • ImpactFuncSet.remove_func()
      • ImpactFuncSet.get_func()
      • ImpactFuncSet.get_hazard_types()
      • ImpactFuncSet.get_ids()
      • ImpactFuncSet.size()
      • ImpactFuncSet.check()
      • ImpactFuncSet.extend()
      • ImpactFuncSet.plot()
      • ImpactFuncSet.from_excel()
      • ImpactFuncSet.read_excel()
      • ImpactFuncSet.from_mat()
      • ImpactFuncSet.read_mat()
      • ImpactFuncSet.write_excel()
  • climada.entity.impact_funcs.storm_europe module
    • ImpfStormEurope
      • ImpfStormEurope.__init__()
      • ImpfStormEurope.from_schwierz()
      • ImpfStormEurope.from_welker()
      • ImpfStormEurope.set_schwierz()
      • ImpfStormEurope.set_welker()
    • IFStormEurope()
  • climada.entity.impact_funcs.trop_cyclone module
    • ImpfTropCyclone
      • ImpfTropCyclone.__init__()
      • ImpfTropCyclone.set_emanuel_usa()
      • ImpfTropCyclone.from_emanuel_usa()
    • ImpfSetTropCyclone
      • ImpfSetTropCyclone.__init__()
      • ImpfSetTropCyclone.set_calibrated_regional_ImpfSet()
      • ImpfSetTropCyclone.from_calibrated_regional_ImpfSet()
      • ImpfSetTropCyclone.calibrated_regional_vhalf()
      • ImpfSetTropCyclone.get_countries_per_region()
      • ImpfSetTropCyclone.get_impf_id_regions_per_countries()
    • IFTropCyclone()
• climada.entity.measures package
  • climada.entity.measures.base module
    • Measure
      • Measure.name
      • Measure.haz_type
      • Measure.color_rgb
      • Measure.cost
      • Measure.hazard_set
      • Measure.hazard_freq_cutoff
      • Measure.exposures_set
      • Measure.imp_fun_map
      • Measure.hazard_inten_imp
      • Measure.mdd_impact
      • Measure.paa_impact
      • Measure.exp_region_id
      • Measure.risk_transf_attach
      • Measure.risk_transf_cover
      • Measure.risk_transf_cost_factor
      • Measure.__init__()
      • Measure.check()
      • Measure.calc_impact()
      • Measure.apply()
  • climada.entity.measures.measure_set module
    • MeasureSet
      • MeasureSet._data
      • MeasureSet.__init__()
      • MeasureSet.clear()
      • MeasureSet.append()
      • MeasureSet.remove_measure()
      • MeasureSet.get_measure()
      • MeasureSet.get_hazard_types()
      • MeasureSet.get_names()
      • MeasureSet.size()
      • MeasureSet.check()
      • MeasureSet.extend()
      • MeasureSet.from_mat()
      • MeasureSet.read_mat()
      • MeasureSet.from_excel()
      • MeasureSet.read_excel()
      • MeasureSet.write_excel()

climada.entity.entity_def module

class climada.entity.entity_def.Entity(exposures: Exposures | None = None, disc_rates: DiscRates | None = None, impact_func_set: ImpactFuncSet | None = None, measure_set: MeasureSet | None = 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 set

Type:

ImpactFuncSet

measures

measures

Type:

MeasureSet

disc_rates

discount rates

Type:

DiscRates

def_file

Default file from configuration file

Type:

str

__init__(exposures: Exposures | None = None, disc_rates: DiscRates | None = None, impact_func_set: ImpactFuncSet | None = None, measure_set: MeasureSet | None = 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)

Read MATLAB file of climada.

Parameters:

file_name (str, optional) – file name(s) or folder name containing the files to read

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)

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 –