Biomass Base Component

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

Bases: aaem.components.annual_savings.annual_savings.AnnualSavings

Biomass 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

Non-residential buildings is 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: ‘Biomass Base’ section of community_data

Methods

calc_annual_electric_savings()

Set electric savings to zero as there are none.

Attributes

annual_electric_savings

(float) set to zero

calc_annual_heating_savings()

Calculate the annual heating savings

Attributes

annual_heating_savings

(Array, Floats) savings in heating cost ($/year)

calc_biomass_fuel_consumed(capacity_factor)

Calculate biomass fuel consumed

Parameters:

capacity_factor : float

TODO:

Attributes

biomass_fuel_consumed

(float) biomass fuel consumed (units/year)

calc_capital_costs()

Calculate the capital costs placeholder.

calc_diesel_displaced()

Calculate the diesel of set by biomass

Attributes

heat_diesel_displaced

(float) heating fuel displaced (gal/year)

calc_displaced_heating_oil_price()

calculate cost of displaced diesel

calc_energy_output()

Calculate the net and monthly energy output of heating oil.

Attributes

average_net_energy_output	(float) average energy output of heating oil(mmbtu/sq. ft./hr).
peak_monthly_energy_output	(float) peak energy out put for a month (mmbtu/sq. ft./hr)

calc_heat_displaced_sqft()

Calculates the square footage for which biomass will displace heating oil as the heating fuel

Attributes

heat_displaced_sqft

(float) Square footage assumed to be heated by biomass.

calc_maintenance_cost()

Calculate the maintenance costs placeholder

Attributes

maintenance_cost

(float) set to zero

calc_max_boiler_output(efficiency)

Calculate the max boiler output.

Parameters:

efficiency : float

Efficiency of biomass fuel.

Attributes

max_boiler_output_per_sf	(float) boiler energy output per square foot (mmbtu/sq. ft.)
max_boiler_output_per	(float) boiler energy output (mmbtu/hr)

calc_proposed_biomass_cost(price)

Calculate cost of biomass fuel.

Attributes

proposed_biomass_cost

(Array of floats) proposed biomass cost ($/year)

get_fuel_total_saved()

Get total fuel saved

Returns:

float

the total fuel saved in gallons

get_non_res_values(non_res)

Get the values necessary to run the biomass component from the non residential buildings component.

Parameters:

non_res : aaem.components.non_residential.CommunityBuildings

is a run non residential buildings component

Attributes

non_res_sqft	(float) square feet in community
avg_gal_per_sqft	(float) average gallons per sq. ft. used in heating

get_total_energy_produced()

Get total energy produced

Returns:

float

the total energy produced

load_prerequisite_variables(comps)

Load variables from prerequisites, placeholder for child components if needed.

Parameters:

comps : Dict

Dictionary of components

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

run the forecast model

pre:

self.cd should be the community library from a community data object

post:

TODO: define output values. the model is run and the output values are available

save_component_csv(directory)

Save the component output csv in directory, place holder

Parameters:

directory : path

output directory

Biomass Base Configuration

Contains Biomass Base configuration info for community data yaml file, and other set-up requirements

Unique Configuration keys

energy density: energy density of fuel

data: data on biomass related items

Biomass Base inputs

input functions for Biomass Base component

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

read the data from biomass_data.csv

Parameters:

data_dir: path

path to data directory for community

Returns:

data : dict

keys are ‘Peak Month % of total’, ‘Capacity Factor’, ‘Distance’, and Sufficient Biomass for 30% of Non-residential buildings

Biomass Base Outputs

No output functions for Biomass component.

Biomass base preprocessing

preprocessing functions for Biomass Base Component

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

preprocess data related to existing projects

Parameters:

preprocessor: preprocessor.Preprocessor

a preprocessor object

Returns:

list

project names