Biomass

Wrapper for SAM Simulation Core model: cmod_biomass.cpp

Creating an Instance

There are three methods to create a new instance of a PySAM module. Using default populates the newclass’ attributes with default values specific to a config. Each technology-financialconfiguration corresponds to a SAM GUI configuration. Using new creates an instance with empty attributes. The wrap function allows compatibility with PySSC, for details, refer to PySSC.

Biomass model description

Biomass combustion for electricity generation

PySAM.Biomass.default(config) → Biomass

Use financial model-specific default attributes config options:

• “BiopowerAllEquityPartnershipFlip”
• “BiopowerCommercial”
• “BiopowerCommercialPPA”
• “BiopowerIndependentPowerProducer”
• “BiopowerLCOECalculator”
• “BiopowerLeveragedPartnershipFlip”
• “BiopowerNone”
• “BiopowerSaleLeaseback”
• “BiopowerSingleOwner”

PySAM.Biomass.new() → Biomass

PySAM.Biomass.wrap(ssc_data_t) → Biomass

Use existing PySSC data

Warning

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

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

Biopower Group

class PySAM.Biomass.Biomass.Biopower

assign() → None

Assign attributes from dictionary

Biopower_vals = { var: val, ...}

export() → dict

Export attributes into dictionary

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

float: Bagasse feedstock fraction

Required: True

biopwr_feedstock_bagasse_moisture

float

Required: True

biopwr_feedstock_barley_frac

float: Barley feedstock fraction

Required: True

biopwr_feedstock_barley_moisture

float

Required: True

biopwr_feedstock_bit_frac

float: Bituminos coal feedstock fraction

Required: True

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

float: Opt feedstock 1 (dt/yr)

Required: True

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

float: Opt feedstock 2 (dt/yr)

Required: True

biopwr_feedstock_forest_frac

float: Forest residue feedstock fraction

Required: True

biopwr_feedstock_forest_moisture

float

Required: True

biopwr_feedstock_herb_c

float: Carbon fraction in herbaceous energy crop

Required: True

biopwr_feedstock_herb_frac

float: Herbaceous energy crop feedstock fraction

Required: True

biopwr_feedstock_herb_moisture

float

Required: True

biopwr_feedstock_lig_frac

float: Lignite coal feedstock fraction

Required: True

biopwr_feedstock_lig_moisture

float

Required: True

biopwr_feedstock_mill_c

float: Carbon fraction in mill residue

Required: True

biopwr_feedstock_mill_frac

float: Mill residue feedstock fraction

Required: True

biopwr_feedstock_mill_moisture

float

Required: True

biopwr_feedstock_rice_frac

float: Rice straw feedstock fraction

Required: True

biopwr_feedstock_rice_moisture

float

Required: True

biopwr_feedstock_stover_frac

float: Stover feedstock fraction

Required: True

biopwr_feedstock_stover_moisture

float

Required: True

biopwr_feedstock_subbit_frac

float: Sub-bituminous coal feedstock fraction

Required: True

biopwr_feedstock_subbit_moisture

float

Required: True

biopwr_feedstock_total

float: Total fuel resource (dt/yr)

Required: True

biopwr_feedstock_total_biomass

float: Total biomass resource (dt/yr)

Required: True

biopwr_feedstock_total_biomass_c

float: Biomass fraction carbon

Required: True

biopwr_feedstock_total_c

float: Mass fraction carbon

Required: True

biopwr_feedstock_total_coal

float: Total coal resource (dt/yr)

Required: True

biopwr_feedstock_total_h

float: Mass fraction hydrogen

Required: True

biopwr_feedstock_total_hhv

float: Dry feedstock HHV (Btu/lb)

Required: True

biopwr_feedstock_total_lhv

float: Dry feedstock LHV (Btu/lb)

Required: True

biopwr_feedstock_total_moisture

float: Overall Moisture Content (dry %)

Required: True

biopwr_feedstock_urban_c

float: Carbon fraction in urban residue

Required: True

biopwr_feedstock_urban_frac

float: Urban wood residue feedstock fraction

Required: True

biopwr_feedstock_urban_moisture

float

Required: True

biopwr_feedstock_wheat_frac

float: Wheat straw feedstock fraction

Required: True

biopwr_feedstock_wheat_moisture

float

Required: True

biopwr_feedstock_woody_c

float: Carbon fraction in woody energy crop

Required: True

biopwr_feedstock_woody_frac

float: Woody energy crop feedstock fraction

Required: True

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

str: Local weather file path

Constraints: LOCAL_FILE

Required: True

system_capacity

float: Nameplate capacity [kW]

Required: True

AdjustmentFactors Group

class PySAM.Biomass.Biomass.AdjustmentFactors

assign() → None

Assign attributes from dictionary

export() → Dict

Export attributes into dictionary

constant

type: float

dc_constant

DC Constant loss adjustment [%]

dc_hourly

DC Hourly Adjustment Factors [%]

dc_periods

DC Period-based Adjustment Factors [%]

hourly

AC Hourly Adjustment Factors [%]

periods

AC Period-based Adjustment Factors [%]

sf_constant

DC Constant loss adjustment [%]

sf_hourly

DC Hourly Adjustment Factors [%]

sf_periods

DC Period-based Adjustment Factors [%]

Outputs Group

class PySAM.Biomass.Biomass.Outputs

assign() → None

Assign attributes from dictionary

Outputs_vals = { var: val, ...}

export() → dict

Export attributes into dictionary

annual_energy

float: Annual Energy [kWh]

annual_fuel_usage

float: Annual Fuel Usage [kWht]

annual_watter_usage

float: Annual Water Usage [m3]

capacity_factor

float: Capacity factor [%]

gen

sequence: System power generated [kW]

hourly_boiler_eff

sequence: Boiler Efficiency

hourly_pbeta

sequence: Power Block Efficiency

hourly_q_to_pb

sequence: Q To Power Block [kW]

kwh_per_kw

float: First year kWh/kW [kWh/kW]

monthly_bagasse_emc

sequence: Monthly bagasse EMC (dry)

monthly_barley_emc

sequence: Monthly barley EMC (dry)

monthly_boiler_eff

sequence: Total Boiler Efficiency - HHV (%) [%]

monthly_energy

sequence: Monthly Energy [kWh]

monthly_forest_emc

sequence: Monthly forest EMC (dry)

monthly_herb_emc

sequence: Monthly herbaceous crop EMC (dry)

monthly_hhv_heatrate

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

monthly_lhv_heatrate

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

monthly_mill_emc

sequence: Monthly mill waste EMC (dry)

monthly_moist

sequence: Monthly biomass moisture fraction (dry)

monthly_pb_eta

sequence: Power Block Effiency [%]

monthly_q_to_pb

sequence: Q To Power Block [kWh]

monthly_rh

sequence: Relative humidity

monthly_rice_emc

sequence: Monthly rice straw EMC (dry)

monthly_stover_emc

sequence: Monthly stover EMC (dry)

monthly_temp_c

sequence: Temperature

monthly_urban_emc

sequence: Monthly urban wood waste EMC (dry)

monthly_wheat_emc

sequence: Monthly wheat straw EMC (dry)

monthly_woody_emc

sequence: Monthly woody crop EMC (dry)

system_annual_ash

float: Ash produced [tons/yr]

system_annual_biomass

float: Annual biomass usage [dry tons/yr]

system_annual_boiler_loss_dry

float: Energy lost in hot flue gas [%]

system_annual_boiler_loss_dry_kwh

float: Energy lost in hot flue gas [kWh]

system_annual_boiler_loss_fuel

float: Energy lost in fuel out of boiler [%]

system_annual_boiler_loss_fuel_kwh

float: Energy lost in fuel out of boiler [kWh]

system_annual_boiler_loss_manu

float: Energy loss included in manufacturer’s margin [%]

system_annual_boiler_loss_manu_kwh

float: Energy loss included in manufacturer’s margin [kWh]

system_annual_boiler_loss_rad

float: Energy loss due to boiler radiation [%]

system_annual_boiler_loss_rad_kwh

float: Energy loss due to boiler radiation [kWh]

system_annual_boiler_loss_total

float: Energy lost in boiler - total [%]

system_annual_boiler_loss_total_kwh

float: Energy lost in boiler - total [kWh]

system_annual_boiler_loss_unburn

float: Energy lost in unburned fuel [%]

system_annual_boiler_loss_unburn_kwh

float: Energy lost in unburned fuel [kWh]

system_annual_boiler_loss_wet

float: Energy lost to moisture in air [%]

system_annual_boiler_loss_wet_kwh

float: Energy lost to moisture in air [kWh]

system_annual_boiler_output

float: Boiler output [kWh]

system_annual_coal

float: Annual coal usage [dry tons/yr]

system_annual_e_net

float: Gross Annual Energy [kWh]

system_annual_par_loss

float: Energy consumed within plant - parasitic load [%]

system_annual_par_loss_kwh

float: Energy consumed within plant - parasitic load [kWh]

system_annual_pb_eta

float: Energy lost in steam turbine and generator [%]

system_annual_pb_eta_kwh

float: Energy lost in steam turbine and generator [kWh]

system_annual_qtoboil_tot

float: Q to Boiler [kWh]

system_annual_qtopb_tot

float: Q to Power Block [kWh]

system_annual_turbine_output

float: Turbine output [kWh]

system_capfactor

float: Annual Capacity Factor (%) [%]

system_emissions_avoided

float: Biomass Avoided Use [kWh]

system_emissions_biodiesel

float: Life Cycle Biodiesel use [Btu/kWh]

system_emissions_bunker

float: Life Cycle Bunker fuel use [Btu/kWh]

system_emissions_combustion

float: Combustion [kWh]

system_emissions_diesel

float: Life Cycle Diesel use [Btu/kWh]

system_emissions_drying

float: Biomass Drying [kWh]

system_emissions_ems_per_lb

float: Life Cycle g CO2eq released/lb dry biomass

system_emissions_growth

float: Biomass Collection [kWh]

system_emissions_lime

float: Life Cycle Lime fertilizer use [lb Lime/kWh]

system_emissions_naturalgas

float: Life Cycle Natural gas use [Btu/kWh]

system_emissions_nitrogen

float: Life Cycle Nitrogen fertilizer use [lb N/kWh]

system_emissions_oil

float: Life Cycle Oil use [Btu/kWh]

system_emissions_phosphorus

float: Life Cycle Phosphorus fertilizer use [lb K2O/kWh]

system_emissions_potassium

float: Life Cycle Potassium fertilizer use [lb P2O5/kWh]

system_emissions_preprocessing

float: Biomass Preprocessing [kWh]

system_emissions_total_sum

float: Biomass Life Cycle CO2 [kWh]

system_emissions_transport

float: Biomass Transport [kWh]

system_emissions_uptake

float: Biomass CO2 Uptake [kWh]

system_heat_rate

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

system_hhv_heatrate

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

system_hhv_thermeff

float: Thermal efficiency, HHV (%) [%]

system_lhv_heatrate

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

system_lhv_thermeff

float: Thermal efficiency, LHV (%) [%]

system_total_moisture

float: Overall Moisture Content (dry %) [%]