Air Source Heat Pump Base Component

class aaem.components.ashp_base.component.ASHPBase(community_data, forecast, diag=None, prerequisites={})[source]

Bases: aaem.components.annual_savings.annual_savings.AnnualSavings

Air source heat pump base of the Alaska Affordable Energy Model: Base component does nothing on it’s own.

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

none required

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: ‘ASHP Base’ section of community_data

Methods

calc_annual_electric_savings()[source]

electric savings placeholder for child components

Attributes

annual_electric_savings (float) set to zero
calc_annual_heating_savings()[source]

calculate heating savings per year

Attributes

annual_heating_savings (float) base heating cost minus the proposed ashp operation cost
calc_ashp_system_parameters()[source]

Calls each of the functions for calculating the ASHP operation parameters

calc_average_cop()[source]

Calculate average yearly coefficient of power(cop) of ASHP system

Attributes

average_cop (float) average yearly coefficient of power(cop) of ASHP system
calc_baseline_heating_oil_cost()[source]

Calculate base line heating fuel cost

Attributes

baseline_heating_oil_cost: array of floats cost of heating oil per year ($/gal)
calc_capital_costs()[source]

sets capital costs to nan, placeholder for child components

Attributes

capital_costs (float) set to Nan
calc_cop_per_month()[source]

calculate the coefficient of performance (COP) per month COP = output/input

Attributes

monthly_value_table: DataFrame DataFrame of monthly values related to ASHP systems
calc_electric_consumption()[source]

calculate the electric consumption for the year

Attributes

electric_consumption: float estimated electric consumption for a year
calc_electric_energy_input_per_month()[source]

calculate kWh produced per month

Attributes

monthly_value_table[‘kWh consumed’] adds kWh consumed per month to the monthly_value_table
calc_heat_energy_produced_per_month()[source]

calc the mmbtu consumed per month

Attributes

monthly_value_table[‘mmbtu/mon’] mmbtu per month is added to the monthly_value_table
calc_heat_energy_produced_per_year()[source]

Calculate the heat energy produced per year by ASHP system (TODO: Double check definition) defined in child components

calc_heating_oil_consumed_per_month()[source]

calculate heating oil consumed per month

Attributes

monthly_value_table[‘Heating Oil Consumed (gal)’] adds kWh consumed per month to the monthly_value_table
calc_heating_oil_saved()[source]

Calculates heating oil saved per year with ASHP system

Attributes

heating_oil_saved (float) Savings in heating oil from ASHP system per year
calc_heating_oil_saved_per_month()[source]

calculate heating oil saved per month

Attributes

monthly_value_table[‘Heating Oil saved(gal)’] adds kWh consumed per month to the monthly_value_table
calc_proposed_ashp_operation_cost()[source]

Calculate cost of operation for new ASHP system

Attributes

proposed_ashp_operation_cos: array of floats cost of electricity for ASHP operation per year ($/kWh)
get_fuel_total_saved()[source]

Get total fuel saved

Returns:

float

the total fuel saved in gallons
get_total_energy_produced()[source]

Get total energy produced

Returns:

float

the total energy produced
load_prerequisite_variables(comps)[source]

Load variables from prerequisites, placeholder for child components if needed

Parameters:

comps : Dict

Dictionary of components
run(scalers={'capital costs': 1.0})[source]

run placeholder for child components

Parameters:

scalers: dictionary of valid scalers, optional

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

Notes

Accepted scalers: capital costs.

save_component_csv(directory)[source]

Save the component output csv in directory, place holder

Parameters:

directory : path

output directory

Air Sorce Heat Pump Base Configuration

Contains Air Sorce Heat Pump Base configuration info for community data yaml file, and other set-up requirements

Air Source Heat Pump Base inputs

input functions for Air Source Heat Pump Base component
aaem.components.ashp_base.inputs.import_perfromance_data(data_dir)

read the data from ashp_perfromance_data.csv

Parameters:

data_dir: path

path to data directory for community
Returns:

data : dict

with ‘Tempeature’, ‘COP’, and ‘PPercent of Total Capacity
aaem.components.ashp_base.inputs.process_data_import(data_dir)

read the data from ashp_climate_data.csv

Parameters:

data_dir: path

path to data directory for community
Returns:

data : DataFrame

cliamte data from component to use

Air Source Heat Pump Base Outputs

output functions for Air Source Heat Pump component

aaem.components.ashp_base.outputs.component_summary(coms, res_dir)[source]

Placeholder for components based on this ASHP_base does nothing

Air Source Heat Pump preprocessing

preprocessing functions for Air Source Heat Pump Base Component
aaem.components.ashp_base.preprocessing.preprocess(preprocessor, **kwargs)[source]

preprocess data related to existing projects

Parameters:

preprocessor: preprocessor.Preprocessor

a preprocessor object
Returns:

list

project names