Water Wastewater Component

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

Bases: aaem.components.annual_savings.annual_savings.AnnualSavings

Wind power component of the Alaska Affordable Energy Model: This module estimates potential improvements in heating and electrical efficiency to water and wastewater systems. Consumption and savings are calculated based on system type, population, and heating degree days per year for a community. Project costs are based on audits, or estimated by the community size.

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 CommintyData 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: ‘water wastewater’ section of community_data

Methods

calc_annual_electric_savings()[source]

Calculate annual electric savings created by the project.

Attributes

annual_electric_savings (np.array) electric savings ($/year) are the difference in the base
and proposed fuel costs  
calc_annual_heating_savings()[source]

Calculate annual heating savings created by the project.

Attributes

annual_heating_savings (np.array) heating savings ($/year)
calc_baseline_HF_consumption()[source]

Calculate the baseline Heating consumption.

Attributes

baseline_fuel_biomass_consumption (np.array) coord/year values(floats) over the project lifetime
baseline_fuel_Hoil_consumption (np.array) gal/year values(floats) over the project lifetime
baseline_HF_consumption (np.array) mmbtu/year values(floats) over the project lifetime
calc_baseline_HF_cost()[source]

Calculate baseline HF cost.

Attributes

baseline_HF_cost (np.array) heating savings ($/year)
calc_baseline_kWh_consumption()[source]

Calculate the baseline electric consumption.

Attributes

baseline_kWh_consumption (np.array) kWh/year values(floats) over the project lifetime
calc_baseline_kWh_cost()[source]

Calculate Baseline electric cost.

Attributes

baseline_generation_cost (np.array) current cost of generation ($/year)
calc_capital_costs(cost_per_person=450)[source]

Calculate the capital costs.

Attributes

capital_costs (float) total cost of improvements ($), calculated from audit cost and population size
calc_proposed_HF_consumption()[source]

Calculate the proposed Heating consumption.

Attributes

proposed_fuel_biomass_consumption (np.array) coord/year values(floats) over the project lifetime
proposed_fuel_Hoil_consumption (np.array) gal/year values(floats) over the project lifetime
proposed_HF_consumption (np.array) mmbtu/year values(floats) over the project lifetime
calc_proposed_HF_cost()[source]

Calculate proposed HF cost.

Attributes

proposed_HF_cost (np.array) heating savings ($/year)
calc_proposed_kWh_consumption()[source]

Calculate the proposed electric consumption.

Attributes

proposed_kWh_consumption (np.array) kWh/year values(floats) over the project lifetime
calc_proposed_kWh_cost()[source]

Calculate Proposed electric cost.

Attributes

proposed_generation_cost (np.array) current cost of generation ($/year)
calc_savings_HF_consumption()[source]

calculate the savings in HF use

Attributes

savings_fuel_Hoil_consumption (np.array) heating oil savings (gal/year)
savings_fuel_biomass_consumption (np.array) heating oil savings (cord/year)
savings_HF_consumption (np.array) heating oil savings (mmbtu/year)
calc_savings_kWh_consumption()[source]

calculate the savings in kWh use

Attributes

savings_kWh_consumption (np.array) electric savings
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

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

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

Water Wastewater Configuration

Contains Water Wastewater configuration info for community data yaml file, and other set-up requirements

Water Wastewater Inputs

input functions for Water Wastewater component

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

Load data from wastewater_data.csv

Parameters:

data_dir: path

path to data directory for community

Returns:

dict

transmission data

Water Wastewater Outputs

output functions for Water Wastewater component

aaem.components.wastewater.outputs.communities_summary(coms, res_dir)[source]

Saves the component summary by community

Parameters:

coms : dictionary

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

res_dir : path

location to save file

aaem.components.wastewater.outputs.component_summary(results, res_dir)[source]

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.wastewater.outputs.create_regional_summary(results)[source]

Creates the regional summary

Parameters:

results : dictionary

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

Returns:

DataFrame

containing regional results

aaem.components.wastewater.outputs.save_regional_summary(summary, res_dir)[source]

Saves the summary by region

Parameters:

summary : DataFrame

compiled regional results

res_dir : path

location to save file

Water Wastewater Preprocessing

preprocessing functions for the Water Wastewater component

aaem.components.wastewater.preprocessing.preprocess(preprocessor, **kwargs)[source]

Preprocess Water/Wastewater data

Parameters:

preprocessor: aaem.preprocessor.Preprocessor object

Returns:

dict

data for component configuration