Biomass

Biomass combustion for electricity generation

PySAM.Biomass.default(config) → Biomass

Load defaults for the configuration config. Available configurations are:

“BiopowerAllEquityPartnershipFlip”

“BiopowerLCOECalculator”

“BiopowerLeveragedPartnershipFlip”

“BiopowerMerchantPlant”

“BiopowerNone”

“BiopowerSaleLeaseback”

“BiopowerSingleOwner”

Note

Some inputs do not have default values and may be assigned a value from the variable’s Required attribute. See variable attribute descriptions below.

PySAM.Biomass.from_existing(data, optional config) → Biomass: Share data with an existing PySAM class. If optional config is a valid configuration name, load the module’s defaults for that configuration.

PySAM.Biomass.new() → Biomass

PySAM.Biomass.wrap(ssc_data_t) → Biomass: Load data from a PySSC object.

Warning

Do not call PySSC.data_free on the ssc_data_t provided to wrap()

Biomass is a wrapper for the SSC compute module cmod_biomass.cpp

Interdependent Variables

The variables listed below are interdependent with other variables. If you change the value of one of these variables, you may need to change values of other variables. The SAM user interface manages these interdependent variables, but in PySAM, it is up to you change the value of all interdependent variables so they are consistent. See Interdependent Variables for examples and details.

None

Functions

class PySAM.Biomass.Biomass

This class contains all the variable information for running a simulation. Variables are grouped together in the subclasses as properties. If property assignments are the wrong type, an error is thrown.

assign(dict) → None

Assign attributes from nested dictionary, except for Outputs

nested_dict = { 'biopower': { var: val, ...}, ...}

execute(int verbosity) → None: Execute simulation with verbosity level 0 (default) or 1

export() → dict: Export attributes into nested dictionary

get_data_ptr() → Pointer: Get ssc_data_t pointer

replace(dict) → None

Replace attributes from nested dictionary, except for Outputs. Unassigns all values in each Group then assigns from the input dict.

nested_dict = { 'biopower': { var: val, ...}, ...}

unassign(name) → None: Unassign a value in any of the variable groups.

value(name, optional value) → None | float | dict | sequence | str: Get or set by name a value in any of the variable groups.

Biopower Group

class PySAM.Biomass.Biomass.Biopower

assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

Biopower_vals = { var: val, ...}

export() → dict: Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

Biopower_vals = { var: val, ...}

biopwr_emissions_avoided_cred

float

Constraints: INTEGER

Required: True

biopwr_emissions_collection_fuel

float

Constraints: INTEGER

Required: True

biopwr_emissions_grid_intensity

float

Required: True

biopwr_emissions_pre_chipopt

float

Constraints: INTEGER

Required: True

biopwr_emissions_pre_grindopt

float

Constraints: INTEGER

Required: True

biopwr_emissions_pre_pelletopt

float

Constraints: INTEGER

Required: True

biopwr_emissions_transport_fuel

float

Constraints: INTEGER

Required: True

biopwr_emissions_transport_legs

float

Constraints: INTEGER

Required: True

biopwr_emissions_transport_long

float

Constraints: INTEGER

Required: True

biopwr_emissions_transport_longmiles

float

Required: True

biopwr_emissions_transport_longopt

float

Constraints: INTEGER

Required: True

biopwr_emissions_transport_predist

float

Required: True

biopwr_feedstock_additional_opt

float

Constraints: INTEGER

Required: True

biopwr_feedstock_bagasse_frac

Bagasse feedstock fraction

Required: True

Type:: float

biopwr_feedstock_bagasse_moisture

float

Required: True

biopwr_feedstock_barley_frac

Barley feedstock fraction

Required: True

Type:: float

biopwr_feedstock_barley_moisture

float

Required: True

biopwr_feedstock_bit_frac

Bituminos coal feedstock fraction

Required: True

Type:: float

biopwr_feedstock_bit_moisture

float

Required: True

biopwr_feedstock_collection_radius

float

Required: True

biopwr_feedstock_feedstock1_c

float

Required: True

biopwr_feedstock_feedstock1_frac

float

Required: True

biopwr_feedstock_feedstock1_h

float

Required: True

biopwr_feedstock_feedstock1_hhv

float

Required: True

biopwr_feedstock_feedstock1_moisture

float

Required: True

biopwr_feedstock_feedstock1_resource

Opt feedstock 1 (dt/yr)

Required: True

Type:: float

biopwr_feedstock_feedstock2_c

float

Required: True

biopwr_feedstock_feedstock2_frac

float

Required: True

biopwr_feedstock_feedstock2_h

float

Required: True

biopwr_feedstock_feedstock2_hhv

float

Required: True

biopwr_feedstock_feedstock2_moisture

float

Required: True

biopwr_feedstock_feedstock2_resource

Opt feedstock 2 (dt/yr)

Required: True

Type:: float

biopwr_feedstock_forest_frac

Forest residue feedstock fraction

Required: True

Type:: float

biopwr_feedstock_forest_moisture

float

Required: True

biopwr_feedstock_herb_c

Carbon fraction in herbaceous energy crop

Required: True

Type:: float

biopwr_feedstock_herb_frac

Herbaceous energy crop feedstock fraction

Required: True

Type:: float

biopwr_feedstock_herb_moisture

float

Required: True

biopwr_feedstock_lig_frac

Lignite coal feedstock fraction

Required: True

Type:: float

biopwr_feedstock_lig_moisture

float

Required: True

biopwr_feedstock_mill_c

Carbon fraction in mill residue

Required: True

Type:: float

biopwr_feedstock_mill_frac

Mill residue feedstock fraction

Required: True

Type:: float

biopwr_feedstock_mill_moisture

float

Required: True

biopwr_feedstock_rice_frac

Rice straw feedstock fraction

Required: True

Type:: float

biopwr_feedstock_rice_moisture

float

Required: True

biopwr_feedstock_stover_frac

Stover feedstock fraction

Required: True

Type:: float

biopwr_feedstock_stover_moisture

float

Required: True

biopwr_feedstock_subbit_frac

Sub-bituminous coal feedstock fraction

Required: True

Type:: float

biopwr_feedstock_subbit_moisture

float

Required: True

biopwr_feedstock_total

Total fuel resource (dt/yr)

Required: True

Type:: float

biopwr_feedstock_total_biomass

Total biomass resource (dt/yr)

Required: True

Type:: float

biopwr_feedstock_total_biomass_c

Biomass fraction carbon

Required: True

Type:: float

biopwr_feedstock_total_c

Mass fraction carbon

Required: True

Type:: float

biopwr_feedstock_total_coal

Total coal resource (dt/yr)

Required: True

Type:: float

biopwr_feedstock_total_h

Mass fraction hydrogen

Required: True

Type:: float

biopwr_feedstock_total_hhv

Dry feedstock HHV (Btu/lb)

Required: True

Type:: float

biopwr_feedstock_total_lhv

Dry feedstock LHV (Btu/lb)

Required: True

Type:: float

biopwr_feedstock_total_moisture

Overall Moisture Content (dry %)

Required: True

Type:: float

biopwr_feedstock_urban_c

Carbon fraction in urban residue

Required: True

Type:: float

biopwr_feedstock_urban_frac

Urban wood residue feedstock fraction

Required: True

Type:: float

biopwr_feedstock_urban_moisture

float

Required: True

biopwr_feedstock_wheat_frac

Wheat straw feedstock fraction

Required: True

Type:: float

biopwr_feedstock_wheat_moisture

float

Required: True

biopwr_feedstock_woody_c

Carbon fraction in woody energy crop

Required: True

Type:: float

biopwr_feedstock_woody_frac

Woody energy crop feedstock fraction

Required: True

Type:: float

biopwr_feedstock_woody_moisture

float

Required: True

biopwr_plant_boiler_air_feed

float

Required: True

biopwr_plant_boiler_cap_per_boiler

float

Required: True

biopwr_plant_boiler_flue_temp

float

Required: True

biopwr_plant_boiler_num

float

Required: True

biopwr_plant_boiler_over_design

float

Required: True

biopwr_plant_boiler_steam_enthalpy

float

Required: True

biopwr_plant_boiler_steam_pressure

float

Required: True

biopwr_plant_combustor_type

float

Constraints: INTEGER

Required: True

biopwr_plant_cycle_design_temp

float

Required: True

biopwr_plant_disp_power

sequence

Constraints: LENGTH=9

Required: True

biopwr_plant_drying_method

float

Constraints: INTEGER

Required: True

biopwr_plant_drying_spec

float

Required: True

biopwr_plant_max_over_design

float

Required: True

biopwr_plant_min_load

float

Required: True

biopwr_plant_nameplate

float

Required: True

biopwr_plant_par_percent

float

Required: True

biopwr_plant_pl_eff_f0

float

Required: True

biopwr_plant_pl_eff_f1

float

Required: True

biopwr_plant_pl_eff_f2

float

Required: True

biopwr_plant_pl_eff_f3

float

Required: True

biopwr_plant_pl_eff_f4

float

Required: True

biopwr_plant_ramp_rate

float

Required: True

biopwr_plant_rated_eff

float

Required: True

biopwr_plant_temp_corr_mode

float

Constraints: INTEGER

Required: True

biopwr_plant_temp_eff_f0

float

Required: True

biopwr_plant_temp_eff_f1

float

Required: True

biopwr_plant_temp_eff_f2

float

Required: True

biopwr_plant_temp_eff_f3

float

Required: True

biopwr_plant_temp_eff_f4

float

Required: True

biopwr_plant_tou_grid

str

Required: True

biopwr_plant_tou_option

float

Constraints: INTEGER

Required: True

file_name

Local weather file path

Constraints: LOCAL_FILE

Required: True

Type:: str

system_capacity

Nameplate capacity [kW]

Required: True

Type:: float

AdjustmentFactors Group

class PySAM.AdjustmentFactors.AdjustmentFactors

assign() → None: Assign attributes from dictionary

export() → Dict: Export attributes into dictionary

constant: AC Constant loss adjustment [%]

dc_constant: DC Constant loss adjustment [%]

dc_en_hourly: Enable DC hourly-based adjustment factors [0/1]

dc_en_periods: Enable DC period-based adjustment factors [0/1]

dc_en_timeindex: Enable DC lfetime adjustment factors [0/1]

dc_hourly: DC Hourly Adjustment Factors [%]

dc_periods: DC Period-based Adjustment Factors [%]

dc_timeindex: DC Lifetime Adjustment Factors [%]

en_hourly: Enable AC hourly-based adjustment factors [0/1]

en_periods: Enable AC period-based adjustment factors [0/1]

en_timeindex: Enable AC lfetime adjustment factors [0/1]

hourly: AC Hourly Adjustment Factors [%]

periods: AC Period-based Adjustment Factors [%]

sf_constant: DC Constant loss adjustment [%]

sf_en_hourly: Enable SF hourly-based adjustment factors [0/1]

sf_en_periods: Enable SF period-based adjustment factors [0/1]

sf_en_timeindex: Enable SF lfetime adjustment factors [0/1]

sf_hourly: SF Hourly Adjustment Factors [%]

sf_periods: SF Period-based Adjustment Factors [%]

sf_timeindex: SF Lifetime Adjustment Factors [%]

timeindex: AC Lifetime Adjustment Factors [%]

Outputs Group

class PySAM.Biomass.Biomass.Outputs

assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

Outputs_vals = { var: val, ...}

export() → dict: Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

Outputs_vals = { var: val, ...}

annual_energy

Annual Energy [kWh]

Type:: float

annual_energy_distribution_time

Annual energy production as function of time [kW]

Type:: sequence[sequence]

annual_fuel_usage

Annual Fuel Usage [kWht]

Type:: float

annual_watter_usage

Annual Water Usage [m3]

Type:: float

capacity_factor

Capacity factor [%]

Type:: float

gen

System power generated [kW]

Type:: sequence

hourly_boiler_eff

Boiler Efficiency

Type:: sequence

hourly_pbeta

Power Block Efficiency

Type:: sequence

hourly_q_to_pb

Q To Power Block [kW]

Type:: sequence

kwh_per_kw

First year kWh/kW [kWh/kW]

Type:: float

monthly_bagasse_emc

Monthly bagasse EMC (dry)

Type:: sequence

monthly_barley_emc

Monthly barley EMC (dry)

Type:: sequence

monthly_boiler_eff

Total Boiler Efficiency - HHV (%) [%]

Type:: sequence

monthly_energy

Monthly Energy Gross [kWh]

Type:: sequence

monthly_forest_emc

Monthly forest EMC (dry)

Type:: sequence

monthly_herb_emc

Monthly herbaceous crop EMC (dry)

Type:: sequence

monthly_hhv_heatrate

Gross Monthly Heat Rate (MMBtu/MWh) [MMBtu/MWh]

Type:: sequence

monthly_lhv_heatrate

Net Monthly Heat Rate (MMBtu/MWh) [MMBtu/MWh]

Type:: sequence

monthly_mill_emc

Monthly mill waste EMC (dry)

Type:: sequence

monthly_moist

Monthly biomass moisture fraction (dry)

Type:: sequence

monthly_pb_eta

Power Block Effiency [%]

Type:: sequence

monthly_q_to_pb

Q To Power Block [kWh]

Type:: sequence

monthly_rh

Relative humidity

Type:: sequence

monthly_rice_emc

Monthly rice straw EMC (dry)

Type:: sequence

monthly_stover_emc

Monthly stover EMC (dry)

Type:: sequence

monthly_temp_c

Temperature

Type:: sequence

monthly_urban_emc

Monthly urban wood waste EMC (dry)

Type:: sequence

monthly_wheat_emc

Monthly wheat straw EMC (dry)

Type:: sequence

monthly_woody_emc

Monthly woody crop EMC (dry)

Type:: sequence

system_annual_ash

Ash produced [tons/yr]

Type:: float

system_annual_biomass

Annual biomass usage [dry tons/yr]

Type:: float

system_annual_boiler_loss_dry

Energy lost in hot flue gas [%]

Type:: float

system_annual_boiler_loss_dry_kwh

Energy lost in hot flue gas [kWh]

Type:: float

system_annual_boiler_loss_fuel

Energy lost in fuel out of boiler [%]

Type:: float

system_annual_boiler_loss_fuel_kwh

Energy lost in fuel out of boiler [kWh]

Type:: float

system_annual_boiler_loss_manu

Energy loss included in manufacturer’s margin [%]

Type:: float

system_annual_boiler_loss_manu_kwh

Energy loss included in manufacturer’s margin [kWh]

Type:: float

system_annual_boiler_loss_rad

Energy loss due to boiler radiation [%]

Type:: float

system_annual_boiler_loss_rad_kwh

Energy loss due to boiler radiation [kWh]

Type:: float

system_annual_boiler_loss_total

Energy lost in boiler - total [%]

Type:: float

system_annual_boiler_loss_total_kwh

Energy lost in boiler - total [kWh]

Type:: float

system_annual_boiler_loss_unburn

Energy lost in unburned fuel [%]

Type:: float

system_annual_boiler_loss_unburn_kwh

Energy lost in unburned fuel [kWh]

Type:: float

system_annual_boiler_loss_wet

Energy lost to moisture in air [%]

Type:: float

system_annual_boiler_loss_wet_kwh

Energy lost to moisture in air [kWh]

Type:: float

system_annual_boiler_output

Boiler output [kWh]

Type:: float

system_annual_coal

Annual coal usage [dry tons/yr]

Type:: float

system_annual_e_net

Gross Annual Energy [kWh]

Type:: float

system_annual_par_loss

Energy consumed within plant - parasitic load [%]

Type:: float

system_annual_par_loss_kwh

Energy consumed within plant - parasitic load [kWh]

Type:: float

system_annual_pb_eta

Energy lost in steam turbine and generator [%]

Type:: float

system_annual_pb_eta_kwh

Energy lost in steam turbine and generator [kWh]

Type:: float

system_annual_qtoboil_tot

Q to Boiler [kWh]

Type:: float

system_annual_qtopb_tot

Q to Power Block [kWh]

Type:: float

system_annual_turbine_output

Turbine output [kWh]

Type:: float

system_capfactor

Annual Capacity Factor (%) [%]

Type:: float

system_emissions_avoided

Biomass Avoided Use [kWh]

Type:: float

system_emissions_biodiesel

Life Cycle Biodiesel use [Btu/kWh]

Type:: float

system_emissions_bunker

Life Cycle Bunker fuel use [Btu/kWh]

Type:: float

system_emissions_combustion

Combustion [kWh]

Type:: float

system_emissions_diesel

Life Cycle Diesel use [Btu/kWh]

Type:: float

system_emissions_drying

Biomass Drying [kWh]

Type:: float

system_emissions_ems_per_lb

Life Cycle g CO2eq released/lb dry biomass

Type:: float

system_emissions_growth

Biomass Collection [kWh]

Type:: float

system_emissions_lime

Life Cycle Lime fertilizer use [lb Lime/kWh]

Type:: float

system_emissions_naturalgas

Life Cycle Natural gas use [Btu/kWh]

Type:: float

system_emissions_nitrogen

Life Cycle Nitrogen fertilizer use [lb N/kWh]

Type:: float

system_emissions_oil

Life Cycle Oil use [Btu/kWh]

Type:: float

system_emissions_phosphorus

Life Cycle Phosphorus fertilizer use [lb K2O/kWh]

Type:: float

system_emissions_potassium

Life Cycle Potassium fertilizer use [lb P2O5/kWh]

Type:: float

system_emissions_preprocessing

Biomass Preprocessing [kWh]

Type:: float

system_emissions_total_sum

Biomass Life Cycle CO2 [kWh]

Type:: float

system_emissions_transport

Biomass Transport [kWh]

Type:: float

system_emissions_uptake

Biomass CO2 Uptake [kWh]

Type:: float

system_heat_rate

Heat Rate Conversion Factor (MMBTUs/MWhe) [MMBTUs/MWhe]

Type:: float

system_hhv_heatrate

Gross Heat Rate (MMBtu/MWh) [MMBtu/MWh]

Type:: float

system_hhv_thermeff

Thermal efficiency, HHV (%) [%]

Type:: float

system_lhv_heatrate

Net Heat Rate (MMBtu/MWh) [MMBtu/MWh]

Type:: float

system_lhv_thermeff

Thermal efficiency, LHV (%) [%]

Type:: float

system_total_moisture

Overall Moisture Content (dry %) [%]

Type:: float