ebm package

Subpackages

• ebm.cmd package
  • Submodules
    • ebm.cmd.calibrate module
      • run_calibration()
      • write_dataframe()
      • main()
    • ebm.cmd.calibrate_excel_com_io module
    • ebm.cmd.heating_systems_by_year module
      • group_heating_systems_energy_source_by_year()
      • group_heating_systems_energy_source_by_year_horizontal()
    • ebm.cmd.helpers module
      • load_environment_from_dotenv()
      • configure_json_log()
      • configure_loglevel()
      • open_file()
    • ebm.cmd.initialize module
      • create_input()
      • copy_available_calibration_files()
      • create_output_directory()
      • init()
      • main()
    • ebm.cmd.migrate module
      • migrate_directories()
      • migrate_directory()
      • main()
    • ebm.cmd.pipeline module
      • main()
      • export_energy_model_reports()
      • load_config()
    • ebm.cmd.prepare_main module
      • EbmConfig
      • make_arguments()
      • check_output_file_status()
    • ebm.cmd.result_handler module
      • transform_model_to_horizontal()
      • transform_to_sorted_heating_systems()
      • transform_heating_systems_to_horizontal()
      • write_result()
      • append_result()
      • EbmDefaultHandler
    • ebm.cmd.run_calculation module
      • area_forecast_result_to_dataframe()
      • result_to_horizontal_dataframe()
      • validate_years()
      • calculate_building_category_energy_requirements()
      • write_to_disk()
      • calculate_building_category_area_forecast()
      • calculate_heating_systems()
  • Module contents
• 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
      • from_norsk()
      • expand_building_category()
      • expand_building_categories()
    • ebm.model.building_condition module
      • BuildingCondition
    • ebm.model.calibrate_energy_requirements module
      • EnergyRequirementCalibrationWriter
      • EnergyConsumptionCalibrationWriter
      • transform()
      • EbmCalibration
      • CalibrationReader
      • CalibrationWriter
    • ebm.model.calibrate_heating_systems module
      • load_area_forecast()
      • load_energy_need()
      • load_heating_systems()
      • transform_by_energy_source()
      • group_heating_systems_by_energy_carrier()
      • transform_pumps()
      • sort_heating_systems_by_energy_source()
      • DistributionOfHeatingSystems
    • 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
    • ebm.model.data_classes module
      • ScurveParameters
      • TEKParameters
      • YearRange
    • ebm.model.database_manager module
      • DatabaseManager
    • ebm.model.dataframemodels module
      • EnergyNeedYearlyImprovements
      • YearlyReduction
      • PolicyImprovement
    • 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
      • 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
      • 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
    • ebm.model.exceptions module
      • AmbiguousDataError
    • ebm.model.file_handler module
      • FileHandler
    • ebm.model.filter_scurve_params module
      • FilterScurveParams
    • ebm.model.filter_tek module
      • FilterTek
    • 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
    • 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
      • main()
    • ebm.model.tek module
  • Module contents
• ebm.services package
  • Submodules
    • ebm.services.calibration_writer module
    • ebm.services.console module
    • ebm.services.excel_loader module
    • ebm.services.files module
      • make_unique_path()
      • file_is_writable()
    • ebm.services.spreadsheet module
      • SpreadsheetCell
      • iter_cells()
      • detect_format_from_values()
      • find_max_column_width()
      • add_top_row_filter()
      • make_pretty()
  • Module contents

Submodules

• ebm.energy_consumption module
  • EnergyConsumption
    • EnergyConsumption.__init__()
    • EnergyConsumption.grouped_heating_systems()
    • EnergyConsumption.calculate()
    • EnergyConsumption.adjust_heat_pump()
    • EnergyConsumption.adjust_other()
    • EnergyConsumption.adjust_cooling()
    • EnergyConsumption.adjust_heating_dhw()
    • EnergyConsumption.adjust_heating_rv()
  • calibrate_heating_systems()
  • calibrate_heating_systems_adder()
• ebm.extractors module
  • extract_area_forecast()
  • write_scurve()
  • extract_energy_need()
  • extract_heating_systems_forecast()
  • extract_energy_use_holiday_homes()
  • main()
• ebm.heating_system_forecast module
  • HeatingSystemsForecast
    • HeatingSystemsForecast.__init__()
    • HeatingSystemsForecast.calculate_forecast()
    • HeatingSystemsForecast.new_instance()
    • HeatingSystemsForecast.pad_projection()
  • add_missing_heating_systems()
  • add_load_shares_and_efficiencies()
  • aggregere_lik_oppvarming_fjern_0()
  • expand_building_category_building_code()
  • project_heating_systems()
  • check_sum_of_shares()
  • add_existing_heating_system_shares_to_projection()
• ebm.holiday_home_energy module
  • HolidayHomeEnergy
    • HolidayHomeEnergy.__init__()
    • HolidayHomeEnergy.calculate_energy_usage()
    • HolidayHomeEnergy.new_instance()
  • project_electricity_usage()
  • project_fuelwood_usage()
  • project_fossil_fuel_usage()
  • sum_holiday_homes()
  • population_over_holiday_homes()
  • projected_holiday_homes()
  • energy_usage_by_holiday_homes()
  • projected_fuelwood_usage_holiday_homes()
  • projected_electricity_usage_holiday_homes()
  • calculate_energy_use()
  • transform_holiday_homes_to_horizontal()
• ebm.migrations module
  • drop_unnamed()
  • rename_columns()
  • drop_columns()
  • translate_heating_system_efficiencies()
  • migrate_input_directory()
• ebm.s_curve module
  • original_condition()
  • small_measure()
  • renovation_and_small_measure()
  • trim_renovation_from_renovation_total()
  • renovation_from_small_measure()
  • total()
  • trim_max_value()
  • small_measure_max()
  • renovation_max()
  • cumulative_renovation()
  • cumulative_small_measure()
  • transform_demolition()
  • transform_to_cumulative_demolition()
  • scurve_parameters_to_never_share()
  • scurve_parameters_to_scurve()
  • accumulate_demolition()
  • merge_s_curves_and_building_code()
  • transform_to_dataframe()
  • transform_to_long()
  • calculate_s_curves()
• ebm.temp_calc module
  • calculate_energy_use_wide()
  • calculate_area_forecast()
  • calculate_energy_need()
• ebm.validators module
  • check_building_category()
  • check_default_building_category()
  • check_default_building_category_with_group()
  • check_building_condition()
  • check_existing_building_conditions()
  • check_all_existing_building_conditions_present()
  • check_energy_purpose()
  • check_default_energy_purpose()
  • check_building_code()
  • check_default_building_code()
  • check_overlapping_building_code_periods()
  • check_building_category_share()
  • create_residential_area_checks()
  • check_heating_systems()
  • check_sum_of_heating_system_shares_equal_1()
  • make_building_purpose()
  • behaviour_factor_parser()
  • calculate_yearly_reduction()
  • heating_system_forecast

Module contents