Heat Recovery Component

class aaem.components.heat_recovery.component.HeatRecovery(community_data, forecast, diag=None, prerequisites={})

Bases: aaem.components.annual_savings.annual_savings.AnnualSavings

Heat recovery component of the Alaska Affordable Energy Model: Insufficient data was available on a community-level to model the costs and benefits of heat recovery. Because of this, the module only includes analysis of projects that have pre-construction studies.

Note

Component requires an existing project for a community to be run to completion.

Parameters:

community_data : CommunityData

CommunityData Object for a community

forecast : Forecast

forecast for a community

diagnostics : diagnostics, optional

diagnostics for tracking error/warning messages

prerequisites : dictionary of components, optional

prerequisite component data this component has no prerequisites leave empty

See also

aaem.community_data

community data module, see information on CommunityData Object

aaem.forecast

forecast module, see information on Forecast Object

aaem.diagnostics

diagnostics module, see information on diagnostics Object

Attributes

diagnostics	(diagnostics) for tracking error/warning messages initial value: diag or new diagnostics object
forecast	(forecast) community forecast for estimating future values initial value: forecast
cd	(dictionary) general data for a community. Initial value: ‘community’ section of community_data
comp_specs	(dictionary) component specific data for a community. Initial value: ‘heat recovery’ section of community_data

Methods

calc_annual_electric_savings()

Set annual electric savings to zero as this component is for improving heating fuel use

Attributes

annual_electric_savings

(float, dollars per year) set to zero

calc_annual_heating_savings()

Calculate Annual Heating Savings, from proposed Heat recovery and Heating Fuel Price.

Attributes

annual_heating_savings

(float, dollars per year) Savings gained by Heat Recovery improvements

calc_capital_costs()

Calculate or Load the project Capital Costs.

Attributes

capital_costs

(float) calculated or loaded capital costs for heat recovery

calc_proposed_heat_recovery()

calculate the proposed heat recovery

Notes

Proposed_heat_recovery currently is only set if there a project for heat recovery in a community.

Attributes

proposed_heat_recovery

(float) calculated or loaded proposed heat recovery

get_fuel_total_saved()

Returns:

float

the total fuel saved in gallons

get_total_energy_produced()

Returns:

float

the total energy produced

run(scalers={'capital costs': 1.0})

runs the component. The Annual Total Savings,Annual Costs, Annual Net Benefit, NPV Benefits, NPV Costs, NPV Net Benefits, Benefit Cost Ratio, Levelized Cost of Energy, and Internal Rate of Return will all be calculated. There must be a known Heat Recovery project for this component to run.

Parameters:

scalers: dictionary of valid scalers, optional

Scalers to adjust normal run variables. See note on accepted scalers

Notes

Accepted scalers: capital costs.

Attributes

run	(bool) True in the component runs to completion, False otherwise
reason	(string) lists reason for failure if run == False

Heat Recovery Configuration

Contains heat recovery configuration info for community data yaml file, and

other set-up requirements

Heat Recovery inputs

input functions for Heat Recovery component

aaem.components.heat_recovery.inputs.load_project_details(data_dir)

load details related to exitign projects

Parameters:

data_dir : path

the path to the input data directory

Returns:

retunrns a dictonary wht the keys ‘phase’(str),

‘proposed capacity’(float), ‘proposed generation’(float), ‘distance to resource’(float), ‘generation capital cost’(float), ‘transmission capital cost’(float), ‘operational costs’(float), ‘expected years to operation’(int)

aaem.components.heat_recovery.inputs.process_data_import(data_dir)

convert input data to useable form

Parameters:

data_dir : path

the path to the input data directory

Returns:

dict

heat recovery project data as a dictonary

Heat Recovery Outputs

output functions for Heat Recovery component

aaem.components.heat_recovery.outputs.communities_summary(coms, res_dir)

Saves the summary by: community heat_recovery_summary.csv

Parameters:

coms : dictionary

results from the model, dictionary with each community or project as key

res_dir : path

location to save file

aaem.components.heat_recovery.outputs.component_summary(results, res_dir)

Creates the regional and communities summary for the component in provided directory

Parameters:

results : dictionary

results from the model, dictionary with each community or project as key

res_dir : path

location to save file

aaem.components.heat_recovery.outputs.create_regional_summary(results)

Creates the regional summary

Parameters:

results : dictionary

results from the model, dictionary with each community or project as key

Returns:

pandas DataFrame containing regional results

aaem.components.heat_recovery.outputs.save_regional_summary(summary, res_dir)

Saves the summary by region: __regional_heat_recovery_summary.csv

Parameters:

summary : DataFrame

compiled regional results

res_dir : path

location to save file

Heat Recovery preprocessing

preprocessing functions for Heat Recovery component

aaem.components.heat_recovery.preprocessing.preprocess(preprocessor, **kwargs)

preprocess data related to existing projects

Parameters:

preprocessor: preprocessor.Preprocessor

a preprocessor object

Returns:

list

project names