Ippppa¶
Wrapper for SAM Simulation Core model: cmod_ippppa.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.
Ippppa model description
Ippppa
-
PySAM.Ippppa.
default
(config) → Ippppa¶ Use financial config-specific default attributes
-
PySAM.Ippppa.
from_existing
(data, optional config) → Ippppa¶ Share underlying data with an existing PySAM class. If config provided, default attributes are loaded otherwise.
-
PySAM.Ippppa.
new
() → Ippppa¶
-
PySAM.Ippppa.
wrap
(ssc_data_t) → Ippppa¶ Use existing PySSC data
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap
Functions¶
-
class
PySAM.Ippppa.
Ippppa
¶ 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 = { 'Financial Parameters': { var: val, ...}, ...}
-
execute
(int verbosity) → None¶ Execute simulation with verbosity level 0 (default) or 1
-
export
() → dict¶ Export attributes into nested dictionary
-
value
(name, optional value) → Union[None, float, dict, sequence, str]¶ Get or set by name a value in any of the variable groups.
-
FinancialParameters Group¶
-
class
PySAM.Ippppa.Ippppa.
FinancialParameters
¶ -
assign
() → None¶ Assign attributes from dictionary
FinancialParameters_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
analysis_period
¶ Analyis period [years]
Constraints: INTEGER,MIN=0,MAX=50
Required: If not provided, assumed to be 30
Type: float
-
debt_fraction
¶ Debt percentage [%]
Constraints: MIN=0,MAX=100
Required: If not provided, assumed to be 0
Type: float
-
federal_tax_rate
¶ Federal income tax rate [%]
Required: True
Type: sequence
-
inflation_rate
¶ Inflation rate [%]
Constraints: MIN=-99
Required: True
Type: float
-
insurance_rate
¶ Insurance rate [%]
Constraints: MIN=0,MAX=100
Required: If not provided, assumed to be 0.0
Type: float
-
loan_rate
¶ Loan rate [%]
Constraints: MIN=0,MAX=100
Required: If not provided, assumed to be 0
Type: float
-
loan_term
¶ Loan term [years]
Constraints: INTEGER,MIN=0,MAX=50
Required: If not provided, assumed to be 0
Type: float
-
prop_tax_assessed_decline
¶ Assessed value annual decline [%]
Constraints: MIN=0,MAX=100
Required: If not provided, assumed to be 5
Type: float
-
prop_tax_cost_assessed_percent
¶ Percent of pre-financing costs assessed [%]
Constraints: MIN=0,MAX=100
Required: If not provided, assumed to be 95
Type: float
-
property_tax_rate
¶ Property tax rate [%]
Constraints: MIN=0,MAX=100
Required: If not provided, assumed to be 0.0
Type: float
-
real_discount_rate
¶ Real discount rate [%]
Constraints: MIN=-99
Required: True
Type: float
-
state_tax_rate
¶ State income tax rate [%]
Required: True
Type: sequence
-
system_capacity
¶ System nameplate capacity [kW]
Constraints: POSITIVE
Required: True
Type: float
-
system_heat_rate
¶ System heat rate [MMBTus/MWh]
Constraints: MIN=0
Required: If not provided, assumed to be 0.0
Type: float
-
SystemCosts Group¶
-
class
PySAM.Ippppa.Ippppa.
SystemCosts
¶ -
assign
() → None¶ Assign attributes from dictionary
SystemCosts_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
add_om_num_types
¶ Number of O and M types
Constraints: INTEGER,MIN=0,MAX=2
Required: If not provided, assumed to be 0
Type: float
-
annual_fuel_usage
¶ Fuel usage (yr 1) [kWht]
Constraints: MIN=0
Required: If not provided, assumed to be 0
Type: float
-
annual_fuel_usage_lifetime
¶ Fuel usage (lifetime) [kWht]
Type: sequence
-
om_capacity
¶ Capacity-based O&M amount [$/kWcap]
Required: If not provided, assumed to be 0.0
Type: sequence
-
om_capacity1
¶ Battery capacity-based System Costs amount [$/kWcap]
Required: If not provided, assumed to be 0.0
Type: sequence
-
om_capacity1_nameplate
¶ Battery capacity for System Costs values [kW]
Required: If not provided, assumed to be 0
Type: float
-
om_capacity2
¶ Fuel cell capacity-based System Costs amount [$/kWcap]
Required: If not provided, assumed to be 0.0
Type: sequence
-
om_capacity2_nameplate
¶ Fuel cell capacity for System Costs values [kW]
Required: If not provided, assumed to be 0
Type: float
-
om_capacity_escal
¶ Capacity-based O&M escalation [%/year]
Required: If not provided, assumed to be 0.0
Type: float
-
om_fixed
¶ Fixed O&M annual amount [$/year]
Required: If not provided, assumed to be 0.0
Type: sequence
-
om_fixed1
¶ Battery fixed System Costs annual amount [$/year]
Required: If not provided, assumed to be 0.0
Type: sequence
-
om_fixed2
¶ Fuel cell fixed System Costs annual amount [$/year]
Required: If not provided, assumed to be 0.0
Type: sequence
-
om_fixed_escal
¶ Fixed O&M escalation [%/year]
Required: If not provided, assumed to be 0.0
Type: float
-
om_fuel_cost
¶ Fuel cost [$/MMBtu]
Required: If not provided, assumed to be 0.0
Type: sequence
-
om_fuel_cost_escal
¶ Fuel cost escalation [%/year]
Required: If not provided, assumed to be 0.0
Type: float
-
om_opt_fuel_1_cost
¶ Biomass feedstock cost [$/unit]
Required: If not provided, assumed to be 0.0
Type: sequence
-
om_opt_fuel_1_cost_escal
¶ Biomass feedstock cost escalation [%/year]
Required: If not provided, assumed to be 0.0
Type: float
-
om_opt_fuel_1_usage
¶ Biomass feedstock usage [unit]
Required: If not provided, assumed to be 0.0
Type: float
-
om_opt_fuel_2_cost
¶ Coal feedstock cost [$/unit]
Required: If not provided, assumed to be 0.0
Type: sequence
-
om_opt_fuel_2_cost_escal
¶ Coal feedstock cost escalation [%/year]
Required: If not provided, assumed to be 0.0
Type: float
-
om_opt_fuel_2_usage
¶ Coal feedstock usage [unit]
Required: If not provided, assumed to be 0.0
Type: float
-
om_production
¶ Production-based O&M amount [$/MWh]
Required: If not provided, assumed to be 0.0
Type: sequence
-
om_production1
¶ Battery production-based System Costs amount [$/MWh]
Required: If not provided, assumed to be 0.0
Type: sequence
-
om_production1_values
¶ Battery production for System Costs values [kWh]
Required: If not provided, assumed to be 0
Type: sequence
-
om_production2
¶ Fuel cell production-based System Costs amount [$/MWh]
Required: If not provided, assumed to be 0.0
Type: sequence
-
om_production2_values
¶ Fuel cell production for System Costs values [kWh]
Required: If not provided, assumed to be 0
Type: sequence
-
om_production_escal
¶ Production-based O&M escalation [%/year]
Required: If not provided, assumed to be 0.0
Type: float
-
om_replacement_cost1
¶ Replacement cost 1 [$/kWh]
Required: If not provided, assumed to be 0.0
Type: sequence
-
om_replacement_cost2
¶ Replacement cost 2 [$/kW]
Required: If not provided, assumed to be 0.0
Type: sequence
-
om_replacement_cost_escal
¶ Replacement cost escalation [%/year]
Required: If not provided, assumed to be 0.0
Type: float
-
Depreciation Group¶
-
class
PySAM.Ippppa.Ippppa.
Depreciation
¶ -
assign
() → None¶ Assign attributes from dictionary
Depreciation_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
depr_fed_custom
¶ Federal custom depreciation [%/year]
Required: True if depr_fed_type=3
Type: sequence
-
depr_fed_sl_years
¶ Federal depreciation straight-line Years [years]
Constraints: INTEGER,POSITIVE
Required: True if depr_fed_type=2
Type: float
-
depr_fed_type
¶ Federal depreciation type
Options: 0=none,1=macrs_half_year,2=sl,3=custom
Constraints: INTEGER,MIN=0,MAX=3
Required: If not provided, assumed to be 0
Type: float
-
depr_sta_custom
¶ State custom depreciation [%/year]
Required: True if depr_sta_type=3
Type: sequence
-
depr_sta_sl_years
¶ State depreciation straight-line years [years]
Constraints: INTEGER,POSITIVE
Required: True if depr_sta_type=2
Type: float
-
depr_sta_type
¶ State depreciation type
Options: 0=none,1=macrs_half_year,2=sl,3=custom
Constraints: INTEGER,MIN=0,MAX=3
Required: If not provided, assumed to be 0
Type: float
-
TaxCreditIncentives Group¶
-
class
PySAM.Ippppa.Ippppa.
TaxCreditIncentives
¶ -
assign
() → None¶ Assign attributes from dictionary
TaxCreditIncentives_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
itc_fed_amount
¶ Federal amount-based ITC amount [$]
Required: If not provided, assumed to be 0
Type: float
-
itc_fed_amount_deprbas_fed
¶ Federal amount-based ITC reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
itc_fed_amount_deprbas_sta
¶ Federal amount-based ITC reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
itc_fed_percent
¶ Federal percentage-based ITC percent [%]
Required: If not provided, assumed to be 0
Type: float
-
itc_fed_percent_deprbas_fed
¶ Federal percentage-based ITC reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
itc_fed_percent_deprbas_sta
¶ Federal percentage-based ITC reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
itc_fed_percent_maxvalue
¶ Federal percentage-based ITC maximum value [$]
Required: If not provided, assumed to be 1e99
Type: float
-
itc_sta_amount
¶ State amount-based ITC amount [$]
Required: If not provided, assumed to be 0
Type: float
-
itc_sta_amount_deprbas_fed
¶ State amount-based ITC reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
itc_sta_amount_deprbas_sta
¶ State amount-based ITC reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
itc_sta_percent
¶ State percentage-based ITC percent [%]
Required: If not provided, assumed to be 0
Type: float
-
itc_sta_percent_deprbas_fed
¶ State percentage-based ITC reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
itc_sta_percent_deprbas_sta
¶ State percentage-based ITC reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
itc_sta_percent_maxvalue
¶ State percentage-based ITC maximum Value [$]
Required: If not provided, assumed to be 1e99
Type: float
-
ptc_fed_amount
¶ Federal PTC amount [$/kWh]
Required: If not provided, assumed to be 0
Type: sequence
-
ptc_fed_escal
¶ Federal PTC escalation [%/year]
Required: If not provided, assumed to be 0
Type: float
-
ptc_fed_term
¶ Federal PTC term [years]
Required: If not provided, assumed to be 10
Type: float
-
ptc_sta_amount
¶ State PTC amount [$/kWh]
Required: If not provided, assumed to be 0
Type: sequence
-
ptc_sta_escal
¶ State PTC escalation [%/year]
Required: If not provided, assumed to be 0
Type: float
-
ptc_sta_term
¶ State PTC term [years]
Required: If not provided, assumed to be 10
Type: float
-
PaymentIncentives Group¶
-
class
PySAM.Ippppa.Ippppa.
PaymentIncentives
¶ -
assign
() → None¶ Assign attributes from dictionary
PaymentIncentives_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
cbi_fed_amount
¶ Federal CBI amount [$/Watt]
Required: If not provided, assumed to be 0.0
Type: float
-
cbi_fed_deprbas_fed
¶ Federal CBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
cbi_fed_deprbas_sta
¶ Federal CBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
cbi_fed_maxvalue
¶ Federal CBI maximum [$]
Required: If not provided, assumed to be 1e99
Type: float
-
cbi_fed_tax_fed
¶ Federal CBI federal taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
cbi_fed_tax_sta
¶ Federal CBI state taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
cbi_oth_amount
¶ Other CBI amount [$/Watt]
Required: If not provided, assumed to be 0.0
Type: float
-
cbi_oth_deprbas_fed
¶ Other CBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
cbi_oth_deprbas_sta
¶ Other CBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
cbi_oth_maxvalue
¶ Other CBI maximum [$]
Required: If not provided, assumed to be 1e99
Type: float
-
cbi_oth_tax_fed
¶ Other CBI federal taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
cbi_oth_tax_sta
¶ Other CBI state taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
cbi_sta_amount
¶ State CBI amount [$/Watt]
Required: If not provided, assumed to be 0.0
Type: float
-
cbi_sta_deprbas_fed
¶ State CBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
cbi_sta_deprbas_sta
¶ State CBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
cbi_sta_maxvalue
¶ State CBI maximum [$]
Required: If not provided, assumed to be 1e99
Type: float
-
cbi_sta_tax_fed
¶ State CBI federal taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
cbi_sta_tax_sta
¶ State CBI state taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
cbi_uti_amount
¶ Utility CBI amount [$/Watt]
Required: If not provided, assumed to be 0.0
Type: float
-
cbi_uti_deprbas_fed
¶ Utility CBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
cbi_uti_deprbas_sta
¶ Utility CBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
cbi_uti_maxvalue
¶ Utility CBI maximum [$]
Required: If not provided, assumed to be 1e99
Type: float
-
cbi_uti_tax_fed
¶ Utility CBI federal taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
cbi_uti_tax_sta
¶ Utility CBI state taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
ibi_fed_amount
¶ Federal amount-based IBI amount [$]
Required: If not provided, assumed to be 0
Type: float
-
ibi_fed_amount_deprbas_fed
¶ Federal amount-based IBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
ibi_fed_amount_deprbas_sta
¶ Federal amount-based IBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
ibi_fed_amount_tax_fed
¶ Federal amount-based IBI federal taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
ibi_fed_amount_tax_sta
¶ Federal amount-based IBI state taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
ibi_fed_percent
¶ Federal percentage-based IBI percent [%]
Required: If not provided, assumed to be 0.0
Type: float
-
ibi_fed_percent_deprbas_fed
¶ Federal percentage-based IBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
ibi_fed_percent_deprbas_sta
¶ Federal percentage-based IBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
ibi_fed_percent_maxvalue
¶ Federal percentage-based IBI maximum value [$]
Required: If not provided, assumed to be 1e99
Type: float
-
ibi_fed_percent_tax_fed
¶ Federal percentage-based IBI federal taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
ibi_fed_percent_tax_sta
¶ Federal percentage-based IBI state taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
ibi_oth_amount
¶ Other amount-based IBI amount [$]
Required: If not provided, assumed to be 0
Type: float
-
ibi_oth_amount_deprbas_fed
¶ Other amount-based IBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
ibi_oth_amount_deprbas_sta
¶ Other amount-based IBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
ibi_oth_amount_tax_fed
¶ Other amount-based IBI federal taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
ibi_oth_amount_tax_sta
¶ Other amount-based IBI state taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
ibi_oth_percent
¶ Other percentage-based IBI percent [%]
Required: If not provided, assumed to be 0.0
Type: float
-
ibi_oth_percent_deprbas_fed
¶ Other percentage-based IBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
ibi_oth_percent_deprbas_sta
¶ Other percentage-based IBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
ibi_oth_percent_maxvalue
¶ Other percentage-based IBI maximum value [$]
Required: If not provided, assumed to be 1e99
Type: float
-
ibi_oth_percent_tax_fed
¶ Other percentage-based IBI federal taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
ibi_oth_percent_tax_sta
¶ Other percentage-based IBI state taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
ibi_sta_amount
¶ State amount-based IBI amount [$]
Required: If not provided, assumed to be 0
Type: float
-
ibi_sta_amount_deprbas_fed
¶ State amount-based IBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
ibi_sta_amount_deprbas_sta
¶ State amount-based IBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
ibi_sta_amount_tax_fed
¶ State amount-based IBI federal taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
ibi_sta_amount_tax_sta
¶ State amount-based IBI state taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
ibi_sta_percent
¶ State percentage-based IBI percent [%]
Required: If not provided, assumed to be 0.0
Type: float
-
ibi_sta_percent_deprbas_fed
¶ State percentage-based IBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
ibi_sta_percent_deprbas_sta
¶ State percentage-based IBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
ibi_sta_percent_maxvalue
¶ State percentage-based IBI maximum value [$]
Required: If not provided, assumed to be 1e99
Type: float
-
ibi_sta_percent_tax_fed
¶ State percentage-based IBI federal taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
ibi_sta_percent_tax_sta
¶ State percentage-based IBI state taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
ibi_uti_amount
¶ Utility amount-based IBI amount [$]
Required: If not provided, assumed to be 0
Type: float
-
ibi_uti_amount_deprbas_fed
¶ Utility amount-based IBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
ibi_uti_amount_deprbas_sta
¶ Utility amount-based IBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
ibi_uti_amount_tax_fed
¶ Utility amount-based IBI federal taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
ibi_uti_amount_tax_sta
¶ Utility amount-based IBI state taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
ibi_uti_percent
¶ Utility percentage-based IBI percent [%]
Required: If not provided, assumed to be 0.0
Type: float
-
ibi_uti_percent_deprbas_fed
¶ Utility percentage-based IBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
ibi_uti_percent_deprbas_sta
¶ Utility percentage-based IBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
ibi_uti_percent_maxvalue
¶ Utility percentage-based IBI maximum value [$]
Required: If not provided, assumed to be 1e99
Type: float
-
ibi_uti_percent_tax_fed
¶ Utility percentage-based IBI federal taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
ibi_uti_percent_tax_sta
¶ Utility percentage-based IBI state taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
pbi_fed_amount
¶ Federal PBI amount [$/kWh]
Required: If not provided, assumed to be 0
Type: sequence
-
pbi_fed_escal
¶ Federal PBI escalation [%]
Required: If not provided, assumed to be 0
Type: float
-
pbi_fed_tax_fed
¶ Federal PBI federal taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
pbi_fed_tax_sta
¶ Federal PBI state taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
pbi_fed_term
¶ Federal PBI term [years]
Required: If not provided, assumed to be 0
Type: float
-
pbi_oth_amount
¶ Other PBI amount [$/kWh]
Required: If not provided, assumed to be 0
Type: sequence
-
pbi_oth_escal
¶ Other PBI escalation [%]
Required: If not provided, assumed to be 0
Type: float
-
pbi_oth_tax_fed
¶ Other PBI federal taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
pbi_oth_tax_sta
¶ Other PBI state taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
pbi_oth_term
¶ Other PBI term [years]
Required: If not provided, assumed to be 0
Type: float
-
pbi_sta_amount
¶ State PBI amount [$/kWh]
Required: If not provided, assumed to be 0
Type: sequence
-
pbi_sta_escal
¶ State PBI escalation [%]
Required: If not provided, assumed to be 0
Type: float
-
pbi_sta_tax_fed
¶ State PBI federal taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
pbi_sta_tax_sta
¶ State PBI state taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
pbi_sta_term
¶ State PBI term [years]
Required: If not provided, assumed to be 0
Type: float
-
pbi_uti_amount
¶ Utility PBI amount [$/kWh]
Required: If not provided, assumed to be 0
Type: sequence
-
pbi_uti_escal
¶ Utility PBI escalation [%]
Required: If not provided, assumed to be 0
Type: float
-
pbi_uti_tax_fed
¶ Utility PBI federal taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
pbi_uti_tax_sta
¶ Utility PBI state taxable [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 1
Type: float
-
pbi_uti_term
¶ Utility PBI term [years]
Required: If not provided, assumed to be 0
Type: float
-
Common Group¶
-
class
PySAM.Ippppa.Ippppa.
Common
¶ -
assign
() → None¶ Assign attributes from dictionary
Common_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
bid_price
¶ Initial year PPA price [$/kWh]
Required: If not provided, assumed to be 0.10
Type: sequence
-
bid_price_esc
¶ PPA escalation [%]
Constraints: MIN=0,MAX=100
Required: If not provided, assumed to be 0
Type: float
-
construction_financing_cost
¶ Construction financing total [$]
Required: True
Type: float
-
degradation
¶ Annual energy degradation
Required: True
Type: sequence
-
dispatch_factor1
¶ Dispatch payment factor 1
Required: True if market=0
Type: float
-
dispatch_factor2
¶ Dispatch payment factor 2
Required: True if market=0
Type: float
-
dispatch_factor3
¶ Dispatch payment factor 3
Required: True if market=0
Type: float
-
dispatch_factor4
¶ Dispatch payment factor 4
Required: True if market=0
Type: float
-
dispatch_factor5
¶ Dispatch payment factor 5
Required: True if market=0
Type: float
-
dispatch_factor6
¶ Dispatch payment factor 6
Required: True if market=0
Type: float
-
dispatch_factor7
¶ Dispatch payment factor 7
Required: True if market=0
Type: float
-
dispatch_factor8
¶ Dispatch payment factor 8
Required: True if market=0
Type: float
-
dispatch_factor9
¶ Dispatch payment factor 9
Required: True if market=0
Type: float
-
dispatch_sched_weekday
¶ Diurnal weekday dispatch periods [1..9]
Info: 12 x 24 matrix
Required: True if market=0
Type: sequence[sequence]
-
dispatch_sched_weekend
¶ Diurnal weekend dispatch periods [1..9]
Info: 12 x 24 matrix
Required: True if market=0
Type: sequence[sequence]
-
gen
¶ Power generated by renewable resource [kW]
Required: True
Type: sequence
-
market
¶ Utility IPP or Commercial PPA [0/1]
Options: 0=ipp,1=ppa
Constraints: INTEGER,MIN=0,MAX=1
Required: If not provided, assumed to be 0
Type: float
-
min_dscr_required
¶ Minimum DSCR required [0/1]
Options: 0=no,1=yes
Constraints: INTEGER,MIN=0,MAX=1
Required: If not provided, assumed to be 1
Type: float
-
min_dscr_target
¶ Minimum required DSCR
Required: If not provided, assumed to be 1.4
Type: float
-
min_irr_target
¶ Minimum required IRR [%]
Required: If not provided, assumed to be 15
Type: float
-
optimize_lcoe_wrt_debt_fraction
¶ Optimize LCOE with respect to debt percent [0/1]
Options: 0=no,1=yes
Constraints: INTEGER,MIN=0,MAX=1
Required: If not provided, assumed to be 0
Type: float
-
optimize_lcoe_wrt_ppa_escalation
¶ Optimize LCOE with respect to PPA escalation [0/1]
Options: 0=no,1=yes
Constraints: INTEGER,MIN=0,MAX=1
Required: If not provided, assumed to be 0
Type: float
-
positive_cashflow_required
¶ Positive cash flow required [0/1]
Options: 0=no,1=yes
Constraints: INTEGER,MIN=0,MAX=1
Required: If not provided, assumed to be 1
Type: float
-
ppa_escalation
¶ PPA escalation [%]
Required: If not provided, assumed to be 0.6
Type: float
-
ppa_soln_max
¶ PPA solution maximum ppa [cents/kWh]
Required: If not provided, assumed to be 100
Type: float
-
ppa_soln_max_iterations
¶ PPA solution maximum number of iterations
Constraints: INTEGER,MIN=1
Required: If not provided, assumed to be 100
Type: float
-
ppa_soln_min
¶ PPA solution minimum ppa [cents/kWh]
Required: If not provided, assumed to be 0
Type: float
-
ppa_soln_tolerance
¶ PPA solution tolerance
Required: If not provided, assumed to be 1e-3
Type: float
-
salvage_percentage
¶ Salvage value percentage [%]
Constraints: MIN=0,MAX=100
Required: If not provided, assumed to be 0.0
Type: float
-
soln_mode
¶ PPA solution mode [0/1]
Options: 0=solve ppa,1=specify ppa
Constraints: INTEGER,MIN=0,MAX=1
Required: If not provided, assumed to be 0
Type: float
-
system_capacity
¶ System nameplate capacity [kW]
Constraints: MIN=1e-3
Required: True
Type: float
-
system_recapitalization_boolean
¶ Recapitalization boolean
Required: If not provided, assumed to be 0
Type: sequence
-
system_recapitalization_cost
¶ Recapitalization cost [$]
Required: If not provided, assumed to be 0
Type: float
-
system_recapitalization_escalation
¶ Recapitalization escalation (above inflation) [%]
Constraints: MIN=0,MAX=100
Required: If not provided, assumed to be 0
Type: float
-
system_use_lifetime_output
¶ Lifetime hourly system outputs [0/1]
Options: 0=hourly first year,1=hourly lifetime
Constraints: INTEGER,MIN=0
Required: True
Type: float
-
system_use_recapitalization
¶ Recapitalization expenses [0/1]
Options: 0=None,1=Recapitalize
Constraints: INTEGER,MIN=0
Required: If not provided, assumed to be 0
Type: float
-
total_installed_cost
¶ Total installed cost [$]
Constraints: MIN=0
Required: True
Type: float
-
Outputs Group¶
-
class
PySAM.Ippppa.Ippppa.
Outputs
¶ -
assign
() → None¶ Assign attributes from dictionary
Outputs_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
actual_debt_frac
¶ Calculated debt fraction [%]
Type: float
-
actual_ppa_escalation
¶ Calculated ppa escalation [%]
Type: float
-
cbi_fedtax_total
¶ Federal taxable CBI income [$]
Type: float
-
cbi_statax_total
¶ State taxable CBI income [$]
Type: float
-
cbi_total
¶ Total CBI income [$]
Type: float
-
cbi_total_fed
¶ Federal CBI income [$]
Type: float
-
cbi_total_oth
¶ Other CBI income [$]
Type: float
-
cbi_total_sta
¶ State CBI income [$]
Type: float
-
cbi_total_uti
¶ Utility CBI income [$]
Type: float
-
cf_after_tax_cash_flow
¶ After-tax cash flow [$]
Type: sequence
-
cf_after_tax_net_equity_cash_flow
¶ After-tax net equity cash flow [$]
Type: sequence
-
cf_after_tax_net_equity_cost_flow
¶ After-tax net equity cost flow [$]
Type: sequence
-
cf_debt_balance
¶ Debt balance [$]
Type: sequence
-
cf_debt_payment_interest
¶ Debt interest payment [$]
Type: sequence
-
cf_debt_payment_principal
¶ Debt principal payment [$]
Type: sequence
-
cf_debt_payment_total
¶ Debt total payment [$]
Type: sequence
-
cf_deductible_expenses
¶ Deductible expenses [$]
Type: sequence
-
cf_degradation
¶ Energy degradation [kWh]
Type: sequence
-
cf_effective_tax_frac
¶ Effective income tax rate [frac]
Type: sequence
-
cf_energy_net
¶ Energy [kWh]
Type: sequence
-
cf_energy_net_apr
¶ Energy produced by the system in April
Type: sequence
-
cf_energy_net_aug
¶ Energy produced by the system in August
Type: sequence
-
cf_energy_net_dec
¶ Energy produced by the system in December
Type: sequence
-
cf_energy_net_dispatch1
¶ Energy produced by the system in dispatch period 1
Type: sequence
-
cf_energy_net_dispatch2
¶ Energy produced by the system in dispatch period 2
Type: sequence
-
cf_energy_net_dispatch3
¶ Energy produced by the system in dispatch period 3
Type: sequence
-
cf_energy_net_dispatch4
¶ Energy produced by the system in dispatch period 4
Type: sequence
-
cf_energy_net_dispatch5
¶ Energy produced by the system in dispatch period 5
Type: sequence
-
cf_energy_net_dispatch6
¶ Energy produced by the system in dispatch period 6
Type: sequence
-
cf_energy_net_dispatch7
¶ Energy produced by the system in dispatch period 7
Type: sequence
-
cf_energy_net_dispatch8
¶ Energy produced by the system in dispatch period 8
Type: sequence
-
cf_energy_net_dispatch9
¶ Energy produced by the system in dispatch period 9
Type: sequence
-
cf_energy_net_feb
¶ Energy produced by the system in February
Type: sequence
-
cf_energy_net_jan
¶ Energy produced by the system in January
Type: sequence
-
cf_energy_net_jul
¶ Energy produced by the system in July
Type: sequence
-
cf_energy_net_jun
¶ Energy produced by the system in June
Type: sequence
-
cf_energy_net_mar
¶ Energy produced by the system in March
Type: sequence
-
cf_energy_net_may
¶ Energy produced by the system in May
Type: sequence
-
cf_energy_net_monthly_firstyear_TOD1
¶ First year energy from the system by month for TOD1
Type: sequence
-
cf_energy_net_monthly_firstyear_TOD2
¶ First year energy from the system by month for TOD2
Type: sequence
-
cf_energy_net_monthly_firstyear_TOD3
¶ First year energy from the system by month for TOD3
Type: sequence
-
cf_energy_net_monthly_firstyear_TOD4
¶ First year energy from the system by month for TOD4
Type: sequence
-
cf_energy_net_monthly_firstyear_TOD5
¶ First year energy from the system by month for TOD5
Type: sequence
-
cf_energy_net_monthly_firstyear_TOD6
¶ First year energy from the system by month for TOD6
Type: sequence
-
cf_energy_net_monthly_firstyear_TOD7
¶ First year energy from the system by month for TOD7
Type: sequence
-
cf_energy_net_monthly_firstyear_TOD8
¶ First year energy from the system by month for TOD8
Type: sequence
-
cf_energy_net_monthly_firstyear_TOD9
¶ First year energy from the system by month for TOD9
Type: sequence
-
cf_energy_net_nov
¶ Energy produced by the system in November
Type: sequence
-
cf_energy_net_oct
¶ Energy produced by the system in October
Type: sequence
-
cf_energy_net_sep
¶ Energy produced by the system in September
Type: sequence
-
cf_energy_price
¶ Energy Price [$/kWh]
Type: sequence
-
cf_energy_value
¶ Energy Value [$]
Type: sequence
-
cf_fed_depr_sched
¶ Federal depreciation schedule [%]
Type: sequence
-
cf_fed_depreciation
¶ Federal depreciation [$]
Type: sequence
-
cf_fed_incentive_income_less_deductions
¶ Federal incentive income less deductions [$]
Type: sequence
-
cf_fed_income_taxes
¶ Federal Income Taxes [$]
Type: sequence
-
cf_fed_tax_savings
¶ Federal tax savings [$]
Type: sequence
-
cf_fed_taxable_income_less_deductions
¶ Federal taxable income less deductions [$]
Type: sequence
-
cf_federal_tax_frac
¶ Federal income tax rate [frac]
Type: sequence
-
cf_insurance_expense
¶ Insurance expense [$]
Type: sequence
-
cf_length
¶ Number of periods in cashflow
Type: float
-
cf_net_salvage_value
¶ Net Salvage Value [$]
Type: sequence
-
cf_om_capacity_expense
¶ O&M capacity-based expense [$]
Type: sequence
-
cf_om_fixed_expense
¶ O&M fixed expense [$]
Type: sequence
-
cf_om_fuel_expense
¶ O&M fuel expense [$]
Type: sequence
-
cf_om_opt_fuel_1_expense
¶ O&M biomass feedstock expense [$]
Type: sequence
-
cf_om_opt_fuel_2_expense
¶ O&M coal feedstock expense [$]
Type: sequence
-
cf_om_production_expense
¶ O&M production-based expense [$]
Type: sequence
-
cf_operating_expenses
¶ Total operating expense [$]
Type: sequence
-
cf_operating_income
¶ Total operating income [$]
Type: sequence
-
cf_pbi_fedtax_total
¶ Federal taxable PBI income [$]
Type: sequence
-
cf_pbi_statax_total
¶ State taxable PBI income [$]
Type: sequence
-
cf_pbi_total
¶ Total PBI income [$]
Type: sequence
-
cf_pbi_total_fed
¶ Federal PBI income [$]
Type: sequence
-
cf_pbi_total_oth
¶ Other PBI income [$]
Type: sequence
-
cf_pbi_total_sta
¶ State PBI income [$]
Type: sequence
-
cf_pbi_total_uti
¶ Utility PBI income [$]
Type: sequence
-
cf_ppa_price
¶ PPA price [cents/kWh]
Type: sequence
-
cf_pretax_dscr
¶ Pre-tax DSCR
Type: sequence
-
cf_property_tax_assessed_value
¶ Property tax net assessed value [$]
Type: sequence
-
cf_property_tax_expense
¶ Property tax expense [$]
Type: sequence
-
cf_ptc_fed
¶ Federal PTC income [$]
Type: sequence
-
cf_ptc_sta
¶ State PTC income [$]
Type: sequence
-
cf_ptc_total
¶ Total PTC [$]
Type: sequence
-
cf_recapitalization
¶ Recapitalization operating expense [$]
Type: sequence
-
cf_revenue_apr
¶ Revenue from the system in April
Type: sequence
-
cf_revenue_aug
¶ Revenue from the system in August
Type: sequence
-
cf_revenue_dec
¶ Revenue from the system in December
Type: sequence
-
cf_revenue_dispatch1
¶ Revenue from the system in dispatch period 1
Type: sequence
-
cf_revenue_dispatch2
¶ Revenue from the system in dispatch period 2
Type: sequence
-
cf_revenue_dispatch3
¶ Revenue from the system in dispatch period 3
Type: sequence
-
cf_revenue_dispatch4
¶ Revenue from the system in dispatch period 4
Type: sequence
-
cf_revenue_dispatch5
¶ Revenue from the system in dispatch period 5
Type: sequence
-
cf_revenue_dispatch6
¶ Revenue from the system in dispatch period 6
Type: sequence
-
cf_revenue_dispatch7
¶ Revenue from the system in dispatch period 7
Type: sequence
-
cf_revenue_dispatch8
¶ Revenue from the system in dispatch period 8
Type: sequence
-
cf_revenue_dispatch9
¶ Revenue from the system in dispatch period 9
Type: sequence
-
cf_revenue_feb
¶ Revenue from the system in February
Type: sequence
-
cf_revenue_jan
¶ Revenue from the system in January
Type: sequence
-
cf_revenue_jul
¶ Revenue from the system in July
Type: sequence
-
cf_revenue_jun
¶ Revenue from the system in June
Type: sequence
-
cf_revenue_mar
¶ Revenue from the system in March
Type: sequence
-
cf_revenue_may
¶ Revenue from the system in May
Type: sequence
-
cf_revenue_monthly_firstyear_TOD1
¶ First year revenue from the system by month for TOD1
Type: sequence
-
cf_revenue_monthly_firstyear_TOD2
¶ First year revenue from the system by month for TOD2
Type: sequence
-
cf_revenue_monthly_firstyear_TOD3
¶ First year revenue from the system by month for TOD3
Type: sequence
-
cf_revenue_monthly_firstyear_TOD4
¶ First year revenue from the system by month for TOD4
Type: sequence
-
cf_revenue_monthly_firstyear_TOD5
¶ First year revenue from the system by month for TOD5
Type: sequence
-
cf_revenue_monthly_firstyear_TOD6
¶ First year revenue from the system by month for TOD6
Type: sequence
-
cf_revenue_monthly_firstyear_TOD7
¶ First year revenue from the system by month for TOD7
Type: sequence
-
cf_revenue_monthly_firstyear_TOD8
¶ First year revenue from the system by month for TOD8
Type: sequence
-
cf_revenue_monthly_firstyear_TOD9
¶ First year revenue from the system by month for TOD9
Type: sequence
-
cf_revenue_nov
¶ Revenue from the system in November
Type: sequence
-
cf_revenue_oct
¶ Revenue from the system in October
Type: sequence
-
cf_revenue_sep
¶ Revenue from the system in September
Type: sequence
-
cf_sta_and_fed_tax_savings
¶ Total tax savings (Federal & State) [$]
Type: sequence
-
cf_sta_depr_sched
¶ State depreciation schedule [%]
Type: sequence
-
cf_sta_depreciation
¶ State depreciation [$]
Type: sequence
-
cf_sta_incentive_income_less_deductions
¶ State incentive income less deductions [$]
Type: sequence
-
cf_sta_income_taxes
¶ State Income Taxes [$]
Type: sequence
-
cf_sta_tax_savings
¶ State tax savings [$]
Type: sequence
-
cf_sta_taxable_income_less_deductions
¶ State taxable income less deductions [$]
Type: sequence
-
cf_state_tax_frac
¶ State income tax rate [frac]
Type: sequence
-
debt_fraction
¶ Debt fraction
Type: float
-
effective_tax_rate
¶ Effective Tax Rate
Type: float
-
firstyear_energy_dispatch1
¶ First year energy from the system in dispatch period 1
Type: float
-
firstyear_energy_dispatch2
¶ First year energy from the system in dispatch period 2
Type: float
-
firstyear_energy_dispatch3
¶ First year energy from the system in dispatch period 3
Type: float
-
firstyear_energy_dispatch4
¶ First year energy from the system in dispatch period 4
Type: float
-
firstyear_energy_dispatch5
¶ First year energy from the system in dispatch period 5
Type: float
-
firstyear_energy_dispatch6
¶ First year energy from the system in dispatch period 6
Type: float
-
firstyear_energy_dispatch7
¶ First year energy from the system in dispatch period 7
Type: float
-
firstyear_energy_dispatch8
¶ First year energy from the system in dispatch period 8
Type: float
-
firstyear_energy_dispatch9
¶ First year energy from the system in dispatch period 9
Type: float
-
firstyear_energy_price1
¶ First year energy price dispatch period 1
Type: float
-
firstyear_energy_price2
¶ First year energy price dispatch period 2
Type: float
-
firstyear_energy_price3
¶ First year energy price dispatch period 3
Type: float
-
firstyear_energy_price4
¶ First year energy price dispatch period 4
Type: float
-
firstyear_energy_price5
¶ First year energy price dispatch period 5
Type: float
-
firstyear_energy_price6
¶ First year energy price dispatch period 6
Type: float
-
firstyear_energy_price7
¶ First year energy price dispatch period 7
Type: float
-
firstyear_energy_price8
¶ First year energy price dispatch period 8
Type: float
-
firstyear_energy_price9
¶ First year energy price dispatch period 9
Type: float
-
firstyear_revenue_dispatch1
¶ First year revenue from the system in dispatch period 1
Type: float
-
firstyear_revenue_dispatch2
¶ First year revenue from the system in dispatch period 2
Type: float
-
firstyear_revenue_dispatch3
¶ First year revenue from the system in dispatch period 3
Type: float
-
firstyear_revenue_dispatch4
¶ First year revenue from the system in dispatch period 4
Type: float
-
firstyear_revenue_dispatch5
¶ First year revenue from the system in dispatch period 5
Type: float
-
firstyear_revenue_dispatch6
¶ First year revenue from the system in dispatch period 6
Type: float
-
firstyear_revenue_dispatch7
¶ First year revenue from the system in dispatch period 7
Type: float
-
firstyear_revenue_dispatch8
¶ First year revenue from the system in dispatch period 8
Type: float
-
firstyear_revenue_dispatch9
¶ First year revenue from the system in dispatch period 9
Type: float
-
ibi_fedtax_total
¶ Federal taxable IBI income [$]
Type: float
-
ibi_statax_total
¶ State taxable IBI income [$]
Type: float
-
ibi_total
¶ Total IBI income [$]
Type: float
-
ibi_total_fed
¶ Federal IBI income [$]
Type: float
-
ibi_total_oth
¶ Other IBI income [$]
Type: float
-
ibi_total_sta
¶ State IBI income [$]
Type: float
-
ibi_total_uti
¶ Utility IBI income [$]
Type: float
-
irr
¶ Internal rate of return [%]
Type: float
-
itc_fed_total
¶ Federal ITC income [$]
Type: float
-
itc_sta_total
¶ State ITC income [$]
Type: float
-
itc_total
¶ Total ITC income [$]
Type: float
-
itc_total_fed
¶ Federal ITC income [$]
Type: float
-
itc_total_sta
¶ State ITC income [$]
Type: float
-
latcf_nom
¶ Nominal LATCF [cents/kWh]
Type: float
-
latcf_real
¶ Real LATCF [cents/kWh]
Type: float
-
lcoe_nom
¶ Nominal LCOE [cents/kWh]
Type: float
-
lcoe_real
¶ Real LCOE [cents/kWh]
Type: float
-
lcoptc_fed_nom
¶ Levelized Federal PTC (nominal) [cents/kWh]
Type: float
-
lcoptc_fed_real
¶ Levelized Federal PTC (real) [cents/kWh]
Type: float
-
lcoptc_sta_nom
¶ Levelized State PTC (nominal) [cents/kWh]
Type: float
-
lcoptc_sta_real
¶ Levelized State PTC (real) [cents/kWh]
Type: float
-
lppa_nom
¶ Nominal LPPA [cents/kWh]
Type: float
-
lppa_real
¶ Real LPPA [cents/kWh]
Type: float
-
min_cashflow
¶ Minimum cash flow value [$]
Type: float
-
min_dscr
¶ Minimum DSCR
Type: float
-
npv
¶ Net present value [$]
Type: float
-
ppa
¶ First year PPA [cents/kWh]
Type: float
-
ppa_escalation
¶ PPA price escalation
Type: float
-
present_value_fuel
¶ Present value of fuel O and M [$]
Type: float
-
present_value_insandproptax
¶ Present value of Insurance and Prop Tax [$]
Type: float
-
present_value_oandm
¶ Present value of O and M [$]
Type: float
-
present_value_oandm_nonfuel
¶ Present value of non-fuel O and M [$]
Type: float
-
wacc
¶ Weighted Average Cost of Capital (WACC)
Type: float
-