ebm.model package

Submodules

• ebm.model.area module
  • transform_area_forecast_to_area_change()
  • transform_cumulative_demolition_to_yearly_demolition()
  • transform_construction_by_year()
  • transform_demolition_construction()
  • merge_building_code_and_condition()
  • filter_existing_area()
  • building_condition_scurves()
  • building_condition_accumulated_scurves()
  • multiply_s_curves_with_floor_area()
  • merge_total_area_by_year()
  • calculate_existing_area()
  • construction_with_building_code()
  • sum_building_category_demolition_by_year()
  • calculate_demolition_floor_area_by_year()
• ebm.model.bema module
  • BUILDING_CATEGORY_ORDER
  • BUILDING_GROUP_ORDER
  • TEK_ORDER
  • PURPOSE_ORDER
  • BUILDING_CONDITION_ORDER
  • START_ROWS_CONSTRUCTION_BUILDING_CATEGORY
  • get_building_category_sheet()
  • map_sort_order()
• ebm.model.building_category module
  • MyEnumType
  • BuildingCategory
    • BuildingCategory.HOUSE
    • BuildingCategory.APARTMENT_BLOCK
    • BuildingCategory.KINDERGARTEN
    • BuildingCategory.SCHOOL
    • BuildingCategory.UNIVERSITY
    • BuildingCategory.OFFICE
    • BuildingCategory.RETAIL
    • BuildingCategory.HOTEL
    • BuildingCategory.HOSPITAL
    • BuildingCategory.NURSING_HOME
    • BuildingCategory.CULTURE
    • BuildingCategory.SPORTS
    • BuildingCategory.STORAGE
    • BuildingCategory.yearly_construction_floor_area()
    • BuildingCategory.is_residential()
    • BuildingCategory.is_non_residential()
    • BuildingCategory.from_string()
  • from_norsk()
  • expand_building_category()
  • expand_building_categories()
• ebm.model.building_condition module
  • BuildingCondition
    • BuildingCondition.ORIGINAL_CONDITION
    • BuildingCondition.SMALL_MEASURE
    • BuildingCondition.RENOVATION
    • BuildingCondition.RENOVATION_AND_SMALL_MEASURE
    • BuildingCondition.DEMOLITION
    • BuildingCondition.get_scruve_condition_list()
    • BuildingCondition.get_full_condition_list()
    • BuildingCondition.existing_conditions()
• ebm.model.calibrate_energy_requirements module
  • EnergyRequirementCalibrationWriter
    • EnergyRequirementCalibrationWriter.__init__()
    • EnergyRequirementCalibrationWriter.load()
  • EnergyConsumptionCalibrationWriter
    • EnergyConsumptionCalibrationWriter.df
    • EnergyConsumptionCalibrationWriter.__init__()
    • EnergyConsumptionCalibrationWriter.transform()
    • EnergyConsumptionCalibrationWriter.load()
  • transform()
  • EbmCalibration
    • EbmCalibration.energy_requirement_original_condition
  • CalibrationReader
    • CalibrationReader.extract()
    • CalibrationReader.transform()
    • CalibrationReader.load()
  • CalibrationWriter
• ebm.model.calibrate_heating_systems module
  • extract_area_forecast()
  • extract_energy_requirements()
  • extract_heating_systems()
  • transform_by_energy_source()
  • group_heating_systems_by_energy_carrier()
  • transform_pumps()
  • sort_heating_systems_by_energy_source()
  • DistributionOfHeatingSystems
    • DistributionOfHeatingSystems.extract()
    • DistributionOfHeatingSystems.transform()
• ebm.model.column_operations module
  • explode_building_category_column()
  • explode_building_code_column()
  • explode_unique_columns()
  • explode_column_alias()
  • replace_column_alias()
  • explode_column()
• ebm.model.construction module
  • ConstructionCalculator
    • ConstructionCalculator.calculate_residential_construction()
    • ConstructionCalculator.calculate_yearly_new_building_floor_area_sum()
    • ConstructionCalculator.calculate_yearly_constructed_floor_area()
    • ConstructionCalculator.calculate_yearly_floor_area_change()
    • ConstructionCalculator.calculate_population_growth()
    • ConstructionCalculator.calculate_building_growth()
    • ConstructionCalculator.calculate_household_change()
    • ConstructionCalculator.calculate_households_by_year()
    • ConstructionCalculator.calculate_industrial_construction()
    • ConstructionCalculator.calculate_total_floor_area()
    • ConstructionCalculator.calculate_constructed_floor_area()
    • ConstructionCalculator.calculate_floor_area_growth()
    • ConstructionCalculator.calculate_floor_area_over_building_growth()
    • ConstructionCalculator.calculate_construction_as_list()
    • ConstructionCalculator.calculate_commercial_construction()
    • ConstructionCalculator.calculate_construction()
    • ConstructionCalculator.calculate_all_construction()
• ebm.model.data_classes module
  • ScurveParameters
    • ScurveParameters.building_category
    • ScurveParameters.condition
    • ScurveParameters.earliest_age
    • ScurveParameters.average_age
    • ScurveParameters.rush_years
    • ScurveParameters.last_age
    • ScurveParameters.rush_share
    • ScurveParameters.never_share
    • ScurveParameters.__init__()
  • TEKParameters
    • TEKParameters.tek
    • TEKParameters.building_year
    • TEKParameters.start_year
    • TEKParameters.end_year
    • TEKParameters.__init__()
  • YearRange
    • YearRange.start
    • YearRange.end
    • YearRange.year_range
    • YearRange.range()
    • YearRange.subset()
    • YearRange.to_index()
    • YearRange.to_dataframe()
    • YearRange.cross_join()
    • YearRange.from_series()
    • YearRange.__init__()
• ebm.model.database_manager module
  • DatabaseManager
    • DatabaseManager.COL_TEK
    • DatabaseManager.COL_TEK_BUILDING_YEAR
    • DatabaseManager.COL_TEK_START_YEAR
    • DatabaseManager.COL_TEK_END_YEAR
    • DatabaseManager.COL_BUILDING_CATEGORY
    • DatabaseManager.COL_BUILDING_CONDITION
    • DatabaseManager.COL_AREA
    • DatabaseManager.COL_ENERGY_REQUIREMENT_PURPOSE
    • DatabaseManager.COL_ENERGY_REQUIREMENT_VALUE
    • DatabaseManager.COL_HEATING_REDUCTION
    • DatabaseManager.DEFAULT_VALUE
    • DatabaseManager.__init__()
    • DatabaseManager.get_building_code_list()
    • DatabaseManager.make_building_purpose()
    • DatabaseManager.get_building_codes()
    • DatabaseManager.get_building_code_params()
    • DatabaseManager.get_scurve_params()
    • DatabaseManager.get_construction_population()
    • DatabaseManager.get_new_buildings_category_share()
    • DatabaseManager.get_building_category_floor_area()
    • DatabaseManager.get_area_parameters()
    • DatabaseManager.get_area_start_year()
    • DatabaseManager.get_behaviour_factor()
    • DatabaseManager.get_energy_req_original_condition()
    • DatabaseManager.get_energy_req_reduction_per_condition()
    • DatabaseManager.get_energy_need_yearly_improvements()
    • DatabaseManager.get_energy_need_policy_improvement()
    • DatabaseManager.get_holiday_home_fuelwood_consumption()
    • DatabaseManager.get_holiday_home_fossilfuel_consumption()
    • DatabaseManager.get_holiday_home_electricity_consumption()
    • DatabaseManager.get_holiday_home_by_year()
    • DatabaseManager.get_calibrate_heating_rv()
    • DatabaseManager.get_calibrate_heating_systems()
    • DatabaseManager.get_area_per_person()
    • DatabaseManager.validate_database()
    • DatabaseManager.get_heating_systems_shares_start_year()
    • DatabaseManager.get_heating_system_efficiencies()
    • DatabaseManager.get_heating_system_forecast()
    • DatabaseManager.explode_unique_columns()
    • DatabaseManager.explode_building_category_column()
    • DatabaseManager.explode_building_code_column()
• ebm.model.dataframemodels module
  • EnergyNeedYearlyImprovements
    • EnergyNeedYearlyImprovements.building_category
    • EnergyNeedYearlyImprovements.building_code
    • EnergyNeedYearlyImprovements.purpose
    • EnergyNeedYearlyImprovements.value
    • EnergyNeedYearlyImprovements.start_year
    • EnergyNeedYearlyImprovements.function
    • EnergyNeedYearlyImprovements.end_year
    • EnergyNeedYearlyImprovements.Config
      • EnergyNeedYearlyImprovements.Config.unique
      • EnergyNeedYearlyImprovements.Config.name
  • YearlyReduction
    • YearlyReduction.building_category
    • YearlyReduction.building_code
    • YearlyReduction.purpose
    • YearlyReduction.start_year
    • YearlyReduction.end_year
    • YearlyReduction.yearly_efficiency_improvement
    • YearlyReduction.Config
      • YearlyReduction.Config.unique
      • YearlyReduction.Config.name
    • YearlyReduction.from_energy_need_yearly_improvements()
  • PolicyImprovement
    • PolicyImprovement.building_category
    • PolicyImprovement.building_code
    • PolicyImprovement.purpose
    • PolicyImprovement.start_year
    • PolicyImprovement.end_year
    • PolicyImprovement.improvement_at_end_year
    • PolicyImprovement.Config
      • PolicyImprovement.Config.unique
      • PolicyImprovement.Config.name
    • PolicyImprovement.start_year_before_end_year()
    • PolicyImprovement.from_energy_need_yearly_improvements()
• ebm.model.defaults module
  • default_calibrate_heating_rv()
  • default_calibrate_energy_consumption()
• ebm.model.energy_need module
  • transform_total_energy_need()
• ebm.model.energy_need_filter module
  • filter_original_condition()
  • filter_improvement_building_upgrade()
  • de_dupe_dataframe()
  • explode_dataframe()
  • main()
• ebm.model.energy_purpose module
  • EnergyPurpose
    • EnergyPurpose.HEATING_RV
    • EnergyPurpose.HEATING_DHW
    • EnergyPurpose.FANS_AND_PUMPS
    • EnergyPurpose.LIGHTING
    • EnergyPurpose.ELECTRICAL_EQUIPMENT
    • EnergyPurpose.COOLING
    • EnergyPurpose.other()
    • EnergyPurpose.heating()
    • EnergyPurpose.cooling()
  • group_energy_use_kwh_by_building_group_purpose_year_wide()
  • group_energy_use_by_year_category_building_code_purpose()
• ebm.model.energy_requirement module
  • yearly_reduction()
  • EnergyRequirement
    • EnergyRequirement.__init__()
    • EnergyRequirement.calculate_for_building_category()
    • EnergyRequirement.calculate_energy_requirement()
    • EnergyRequirement.calculate_energy_reduction()
    • EnergyRequirement.merge_energy_requirement_reductions()
    • EnergyRequirement.calculate_reduction_yearly()
    • EnergyRequirement.calculate_reduction_policy()
    • EnergyRequirement.calculate_reduction_condition()
    • EnergyRequirement.calculate_energy_requirements()
    • EnergyRequirement.new_instance()
  • main()
• ebm.model.energy_use module
  • base_load()
  • peak_load()
  • tertiary_load()
  • heating_rv()
  • heating_dhw()
  • cooling()
  • other()
  • all_purposes()
  • efficiency_factor()
  • energy_use_kwh()
  • building_group_energy_use_kwh()
  • energy_use_gwh_by_building_group()
  • calculate_energy_use()
• ebm.model.enums module
  • ReturnCode
    • ReturnCode.OK
    • ReturnCode.FILE_EXISTS
    • ReturnCode.FILE_NOT_ACCESSIBLE
    • ReturnCode.MISSING_INPUT_FILES
• ebm.model.exceptions module
  • AmbiguousDataError
• ebm.model.file_handler module
  • FileHandler
    • FileHandler.BUILDING_CONDITIONS
    • FileHandler.BUILDING_CODE_PARAMS
    • FileHandler.S_CURVE
    • FileHandler.POPULATION_FORECAST
    • FileHandler.NEW_BUILDINGS_RESIDENTIAL
    • FileHandler.AREA_NEW_RESIDENTIAL_BUILDINGS
    • FileHandler.AREA
    • FileHandler.BEHAVIOUR_FACTOR
    • FileHandler.ENERGY_NEED_ORIGINAL_CONDITION
    • FileHandler.IMPROVEMENT_BUILDING_UPGRADE
    • FileHandler.ENERGY_NEED_YEARLY_IMPROVEMENTS
    • FileHandler.HOLIDAY_HOME_STOCK
    • FileHandler.HOLIDAY_HOME_ENERGY_CONSUMPTION
    • FileHandler.AREA_PER_PERSON
    • FileHandler.HEATING_SYSTEM_INITIAL_SHARES
    • FileHandler.HEATING_SYSTEM_EFFICIENCIES
    • FileHandler.HEATING_SYSTEM_FORECAST
    • FileHandler.CALIBRATE_ENERGY_REQUIREMENT
    • FileHandler.CALIBRATE_ENERGY_CONSUMPTION
    • FileHandler.__init__()
    • FileHandler.input_directory
    • FileHandler.default_data_directory()
    • FileHandler.get_file()
    • FileHandler.get_building_code()
    • FileHandler.get_s_curve()
    • FileHandler.get_construction_population()
    • FileHandler.get_population()
    • FileHandler.get_construction_building_category_share()
    • FileHandler.get_building_category_area()
    • FileHandler.get_area_parameters()
    • FileHandler.get_energy_req_original_condition()
    • FileHandler.get_energy_req_reduction_per_condition()
    • FileHandler.get_energy_need_yearly_improvements()
    • FileHandler.get_holiday_home_energy_consumption()
    • FileHandler.get_holiday_home_by_year()
    • FileHandler.get_area_per_person()
    • FileHandler.get_calibrate_heating_rv()
    • FileHandler.get_calibrate_heating_systems()
    • FileHandler.get_heating_systems_shares_start_year()
    • FileHandler.get_heating_system_efficiencies()
    • FileHandler.get_heating_system_forecast()
    • FileHandler.check_for_missing_files()
    • FileHandler.create_missing_input_files()
    • FileHandler.create_input_file()
    • FileHandler.validate_input_files()
    • FileHandler.is_calibrated()
• ebm.model.filter_scurve_params module
  • FilterScurveParams
    • FilterScurveParams.COL_BUILDING_CATEGORY
    • FilterScurveParams.COL_BUILDING_CONDITION
    • FilterScurveParams.COL_EARLIEST_AGE
    • FilterScurveParams.COL_AVERAGE_AGE
    • FilterScurveParams.COL_LAST_AGE
    • FilterScurveParams.COL_RUSH_YEARS
    • FilterScurveParams.COL_RUSH_SHARE
    • FilterScurveParams.COL_NEVER_SHARE
    • FilterScurveParams.filter()
• ebm.model.filter_tek module
  • FilterTek
    • FilterTek.CATEGORY_APARTMENT
    • FilterTek.CATEGORY_HOUSE
    • FilterTek.COMMERCIAL_BUILDING
    • FilterTek.RESIDENTIAL_BUILDING
    • FilterTek.PRE_TEK49_APARTMENT
    • FilterTek.PRE_TEK49_HOUSE
    • FilterTek.get_filtered_list()
    • FilterTek.get_filtered_params()
    • FilterTek.merge_building_code()
    • FilterTek.remove_building_code_suffix()
• ebm.model.heat_pump module
  • air_source_heat_pump()
  • district_heating_heat_pump()
  • heat_pump_production()
  • heat_prod_hp()
  • heat_prod_hp_wide()
• ebm.model.heating_systems module
  • HeatingSystems
    • HeatingSystems.ELECTRICITY
    • HeatingSystems.ELECTRICITY_BIO
    • HeatingSystems.ELECTRIC_BOILER
    • HeatingSystems.ELECTRIC_BOILER_SOLAR
    • HeatingSystems.GAS
    • HeatingSystems.DISTRICT_HEATING
    • HeatingSystems.DISTRICT_HEATING_BIO
    • HeatingSystems.HP_BIO
    • HeatingSystems.HP_ELECTRICITY
    • HeatingSystems.HP_CENTRAL_HEATING
    • HeatingSystems.HP_CENTRAL_HEATING_GAS
    • HeatingSystems.HP_CENTRAL_HEATING_BIO
• ebm.model.heating_systems_parameter module
  • heating_systems_parameter_from_projection()
  • expand_heating_system_parameters()
• ebm.model.heating_systems_projection module
• ebm.model.heating_systems_share module
  • transform_heating_systems_share_long()
  • transform_heating_systems_share_wide()
• ebm.model.scurve module
  • SCurve
    • SCurve.earliest_age
    • SCurve.average_age
    • SCurve.last_age
    • SCurve.rush_years
    • SCurve.rush_share
    • SCurve.never_share
    • SCurve.building_lifetime
    • SCurve.__init__()
    • SCurve.get_rates_per_year_over_building_lifetime()
    • SCurve.calc_scurve()
  • main()
• ebm.model.tek module

Module contents