Cashloan¶
Wrapper for SAM Simulation Core model: cmod_cashloan.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.
CashloanModel model description
Financial model for residential and commercial behind-the-meter projects
-
PySAM.CashloanModel.default(config) → CashloanModel¶ Use financial model-specific default attributes config options:
- “BiopowerCommercial”
- “DSLFCommercial”
- “DishStirlingCommercial”
- “EmpiricalTroughCommercial”
- “FlatPlatePVCommercial”
- “FlatPlatePVResidential”
- “FuelCellCommercial”
- “GenericCSPSystemCommercial”
- “GenericSystemCommercial”
- “GenericSystemResidential”
- “MSLFCommercial”
- “PVWattsCommercial”
- “PVWattsResidential”
- “PhysicalTroughCommercial”
- “SolarWaterHeatingCommercial”
- “SolarWaterHeatingResidential”
- “WindPowerCommercial”
- “WindPowerResidential”
-
PySAM.CashloanModel.new() → CashloanModel¶
-
PySAM.CashloanModel.wrap(ssc_data_t) → CashloanModel¶ Use existing PySSC data
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap
Functions¶
-
class
PySAM.CashloanModel.CashloanModel¶ 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
-
FinancialParameters Group¶
-
class
PySAM.CashloanModel.CashloanModel.FinancialParameters¶ -
assign() → None¶ Assign attributes from dictionary
FinancialParameters_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
analysis_period¶ float: Analyis period [years]
Constraints: INTEGER,MIN=0,MAX=50
Required: set to 30 if not provided.
-
debt_fraction¶ float: Debt percentage [%]
Constraints: MIN=0,MAX=100
Required: set to 0 if not provided.
-
federal_tax_rate¶ sequence: Federal income tax rate [%]
Required: True
-
inflation_rate¶ float: Inflation rate [%]
Constraints: MIN=-99
Required: True
-
insurance_rate¶ float: Insurance rate [%]
Constraints: MIN=0,MAX=100
Required: set to 0.0 if not provided.
-
loan_rate¶ float: Loan rate [%]
Constraints: MIN=0,MAX=100
Required: set to 0 if not provided.
-
loan_term¶ float: Loan term [years]
Constraints: INTEGER,MIN=0,MAX=50
Required: set to 0 if not provided.
-
prop_tax_assessed_decline¶ float: Assessed value annual decline [%]
Constraints: MIN=0,MAX=100
Required: set to 5 if not provided.
-
prop_tax_cost_assessed_percent¶ float: Percent of pre-financing costs assessed [%]
Constraints: MIN=0,MAX=100
Required: set to 95 if not provided.
-
property_tax_rate¶ float: Property tax rate [%]
Constraints: MIN=0,MAX=100
Required: set to 0.0 if not provided.
-
real_discount_rate¶ float: Real discount rate [%]
Constraints: MIN=-99
Required: True
-
state_tax_rate¶ sequence: State income tax rate [%]
Required: True
-
system_capacity¶ float: System nameplate capacity [kW]
Constraints: POSITIVE
Required: True
-
system_heat_rate¶ float: System heat rate [MMBTus/MWh]
Constraints: MIN=0
Required: set to 0.0 if not provided.
-
SystemCosts Group¶
-
class
PySAM.CashloanModel.CashloanModel.SystemCosts¶ -
assign() → None¶ Assign attributes from dictionary
SystemCosts_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
add_om_num_types¶ float: Number of O and M types
Constraints: INTEGER,MIN=0,MAX=2
Required: set to 0 if not provided.
-
annual_fuel_usage¶ float: Fuel usage [kWht]
Constraints: MIN=0
Required: set to 0 if not provided.
-
om_capacity¶ sequence: Capacity-based System Costs amount [$/kWcap]
Required: set to 0.0 if not provided.
-
om_capacity1¶ sequence: Battery capacity-based System Costs amount [$/kWcap]
Required: set to 0.0 if not provided.
-
om_capacity1_nameplate¶ float: Battery capacity for System Costs values [kW]
Required: set to 0 if not provided.
-
om_capacity2¶ sequence: Fuel cell capacity-based System Costs amount [$/kWcap]
Required: set to 0.0 if not provided.
-
om_capacity2_nameplate¶ float: Fuel cell capacity for System Costs values [kW]
Required: set to 0 if not provided.
-
om_capacity_escal¶ float: Capacity-based System Costs escalation [%/year]
Required: set to 0.0 if not provided.
-
om_fixed¶ sequence: Fixed System Costs annual amount [$/year]
Required: set to 0.0 if not provided.
-
om_fixed1¶ sequence: Battery fixed System Costs annual amount [$/year]
Required: set to 0.0 if not provided.
-
om_fixed2¶ sequence: Fuel cell fixed System Costs annual amount [$/year]
Required: set to 0.0 if not provided.
-
om_fixed_escal¶ float: Fixed System Costs escalation [%/year]
Required: set to 0.0 if not provided.
-
om_fuel_cost¶ sequence: Fuel cost [$/MMBtu]
Required: set to 0.0 if not provided.
-
om_fuel_cost_escal¶ float: Fuel cost escalation [%/year]
Required: set to 0.0 if not provided.
-
om_opt_fuel_1_cost¶ sequence: Biomass feedstock cost [$/unit]
Required: set to 0.0 if not provided.
-
om_opt_fuel_1_cost_escal¶ float: Biomass feedstock cost escalation [%/year]
Required: set to 0.0 if not provided.
-
om_opt_fuel_1_usage¶ float: Biomass feedstock usage [unit]
Required: set to 0.0 if not provided.
-
om_opt_fuel_2_cost¶ sequence: Coal feedstock cost [$/unit]
Required: set to 0.0 if not provided.
-
om_opt_fuel_2_cost_escal¶ float: Coal feedstock cost escalation [%/year]
Required: set to 0.0 if not provided.
-
om_opt_fuel_2_usage¶ float: Coal feedstock usage [unit]
Required: set to 0.0 if not provided.
-
om_production¶ sequence: Production-based System Costs amount [$/MWh]
Required: set to 0.0 if not provided.
-
om_production1¶ sequence: Battery production-based System Costs amount [$/MWh]
Required: set to 0.0 if not provided.
-
om_production1_values¶ sequence: Battery production for System Costs values [kWh]
Required: set to 0 if not provided.
-
om_production2¶ sequence: Fuel cell production-based System Costs amount [$/MWh]
Required: set to 0.0 if not provided.
-
om_production2_values¶ sequence: Fuel cell production for System Costs values [kWh]
Required: set to 0 if not provided.
-
om_production_escal¶ float: Production-based System Costs escalation [%/year]
Required: set to 0.0 if not provided.
-
om_replacement_cost1¶ sequence: Repacement cost 1 [$/kWh]
Required: set to 0.0 if not provided.
-
om_replacement_cost2¶ sequence: Repacement cost 2 [$/kW]
Required: set to 0.0 if not provided.
-
om_replacement_cost_escal¶ float: Replacement cost escalation [%/year]
Required: set to 0.0 if not provided.
-
Depreciation Group¶
-
class
PySAM.CashloanModel.CashloanModel.Depreciation¶ -
assign() → None¶ Assign attributes from dictionary
Depreciation_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
depr_fed_custom¶ sequence: Federal custom depreciation [%/year]
Required: set to 3 if not provided.
-
depr_fed_sl_years¶ float: Federal depreciation straight-line Years [years]
Constraints: INTEGER,POSITIVE
Required: set to 2 if not provided.
-
depr_fed_type¶ float: Federal depreciation type
Options: 0=none,1=macrs_half_year,2=sl,3=custom
Constraints: INTEGER,MIN=0,MAX=3
Required: set to 0 if not provided.
-
depr_sta_custom¶ sequence: State custom depreciation [%/year]
Required: set to 3 if not provided.
-
depr_sta_sl_years¶ float: State depreciation straight-line years [years]
Constraints: INTEGER,POSITIVE
Required: set to 2 if not provided.
-
depr_sta_type¶ float: State depreciation type
Options: 0=none,1=macrs_half_year,2=sl,3=custom
Constraints: INTEGER,MIN=0,MAX=3
Required: set to 0 if not provided.
-
TaxCreditIncentives Group¶
-
class
PySAM.CashloanModel.CashloanModel.TaxCreditIncentives¶ -
assign() → None¶ Assign attributes from dictionary
TaxCreditIncentives_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
itc_fed_amount¶ float: Federal amount-based ITC amount [$]
Required: set to 0 if not provided.
-
itc_fed_amount_deprbas_fed¶ float: Federal amount-based ITC reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
itc_fed_amount_deprbas_sta¶ float: Federal amount-based ITC reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
itc_fed_percent¶ float: Federal percentage-based ITC percent [%]
Required: set to 0 if not provided.
-
itc_fed_percent_deprbas_fed¶ float: Federal percentage-based ITC reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
itc_fed_percent_deprbas_sta¶ float: Federal percentage-based ITC reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
itc_fed_percent_maxvalue¶ float: Federal percentage-based ITC maximum value [$]
Required: set to 1e99 if not provided.
-
itc_sta_amount¶ float: State amount-based ITC amount [$]
Required: set to 0 if not provided.
-
itc_sta_amount_deprbas_fed¶ float: State amount-based ITC reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
itc_sta_amount_deprbas_sta¶ float: State amount-based ITC reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
itc_sta_percent¶ float: State percentage-based ITC percent [%]
Required: set to 0 if not provided.
-
itc_sta_percent_deprbas_fed¶ float: State percentage-based ITC reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
itc_sta_percent_deprbas_sta¶ float: State percentage-based ITC reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
itc_sta_percent_maxvalue¶ float: State percentage-based ITC maximum Value [$]
Required: set to 1e99 if not provided.
-
ptc_fed_amount¶ sequence: Federal PTC amount [$/kWh]
Required: set to 0 if not provided.
-
ptc_fed_escal¶ float: Federal PTC escalation [%/year]
Required: set to 0 if not provided.
-
ptc_fed_term¶ float: Federal PTC term [years]
Required: set to 10 if not provided.
-
ptc_sta_amount¶ sequence: State PTC amount [$/kWh]
Required: set to 0 if not provided.
-
ptc_sta_escal¶ float: State PTC escalation [%/year]
Required: set to 0 if not provided.
-
ptc_sta_term¶ float: State PTC term [years]
Required: set to 10 if not provided.
-
PaymentIncentives Group¶
-
class
PySAM.CashloanModel.CashloanModel.PaymentIncentives¶ -
assign() → None¶ Assign attributes from dictionary
PaymentIncentives_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
cbi_fed_amount¶ float: Federal CBI amount [$/Watt]
Required: set to 0.0 if not provided.
-
cbi_fed_deprbas_fed¶ float: Federal CBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
cbi_fed_deprbas_sta¶ float: Federal CBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
cbi_fed_maxvalue¶ float: Federal CBI maximum [$]
Required: set to 1e99 if not provided.
-
cbi_fed_tax_fed¶ float: Federal CBI federal taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
cbi_fed_tax_sta¶ float: Federal CBI state taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
cbi_oth_amount¶ float: Other CBI amount [$/Watt]
Required: set to 0.0 if not provided.
-
cbi_oth_deprbas_fed¶ float: Other CBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
cbi_oth_deprbas_sta¶ float: Other CBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
cbi_oth_maxvalue¶ float: Other CBI maximum [$]
Required: set to 1e99 if not provided.
-
cbi_oth_tax_fed¶ float: Other CBI federal taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
cbi_oth_tax_sta¶ float: Other CBI state taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
cbi_sta_amount¶ float: State CBI amount [$/Watt]
Required: set to 0.0 if not provided.
-
cbi_sta_deprbas_fed¶ float: State CBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
cbi_sta_deprbas_sta¶ float: State CBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
cbi_sta_maxvalue¶ float: State CBI maximum [$]
Required: set to 1e99 if not provided.
-
cbi_sta_tax_fed¶ float: State CBI federal taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
cbi_sta_tax_sta¶ float: State CBI state taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
cbi_uti_amount¶ float: Utility CBI amount [$/Watt]
Required: set to 0.0 if not provided.
-
cbi_uti_deprbas_fed¶ float: Utility CBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
cbi_uti_deprbas_sta¶ float: Utility CBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
cbi_uti_maxvalue¶ float: Utility CBI maximum [$]
Required: set to 1e99 if not provided.
-
cbi_uti_tax_fed¶ float: Utility CBI federal taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
cbi_uti_tax_sta¶ float: Utility CBI state taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
ibi_fed_amount¶ float: Federal amount-based IBI amount [$]
Required: set to 0 if not provided.
-
ibi_fed_amount_deprbas_fed¶ float: Federal amount-based IBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
ibi_fed_amount_deprbas_sta¶ float: Federal amount-based IBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
ibi_fed_amount_tax_fed¶ float: Federal amount-based IBI federal taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
ibi_fed_amount_tax_sta¶ float: Federal amount-based IBI state taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
ibi_fed_percent¶ float: Federal percentage-based IBI percent [%]
Required: set to 0.0 if not provided.
-
ibi_fed_percent_deprbas_fed¶ float: Federal percentage-based IBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
ibi_fed_percent_deprbas_sta¶ float: Federal percentage-based IBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
ibi_fed_percent_maxvalue¶ float: Federal percentage-based IBI maximum value [$]
Required: set to 1e99 if not provided.
-
ibi_fed_percent_tax_fed¶ float: Federal percentage-based IBI federal taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
ibi_fed_percent_tax_sta¶ float: Federal percentage-based IBI state taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
ibi_oth_amount¶ float: Other amount-based IBI amount [$]
Required: set to 0 if not provided.
-
ibi_oth_amount_deprbas_fed¶ float: Other amount-based IBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
ibi_oth_amount_deprbas_sta¶ float: Other amount-based IBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
ibi_oth_amount_tax_fed¶ float: Other amount-based IBI federal taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
ibi_oth_amount_tax_sta¶ float: Other amount-based IBI state taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
ibi_oth_percent¶ float: Other percentage-based IBI percent [%]
Required: set to 0.0 if not provided.
-
ibi_oth_percent_deprbas_fed¶ float: Other percentage-based IBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
ibi_oth_percent_deprbas_sta¶ float: Other percentage-based IBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
ibi_oth_percent_maxvalue¶ float: Other percentage-based IBI maximum value [$]
Required: set to 1e99 if not provided.
-
ibi_oth_percent_tax_fed¶ float: Other percentage-based IBI federal taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
ibi_oth_percent_tax_sta¶ float: Other percentage-based IBI state taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
ibi_sta_amount¶ float: State amount-based IBI amount [$]
Required: set to 0 if not provided.
-
ibi_sta_amount_deprbas_fed¶ float: State amount-based IBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
ibi_sta_amount_deprbas_sta¶ float: State amount-based IBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
ibi_sta_amount_tax_fed¶ float: State amount-based IBI federal taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
ibi_sta_amount_tax_sta¶ float: State amount-based IBI state taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
ibi_sta_percent¶ float: State percentage-based IBI percent [%]
Required: set to 0.0 if not provided.
-
ibi_sta_percent_deprbas_fed¶ float: State percentage-based IBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
ibi_sta_percent_deprbas_sta¶ float: State percentage-based IBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
ibi_sta_percent_maxvalue¶ float: State percentage-based IBI maximum value [$]
Required: set to 1e99 if not provided.
-
ibi_sta_percent_tax_fed¶ float: State percentage-based IBI federal taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
ibi_sta_percent_tax_sta¶ float: State percentage-based IBI state taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
ibi_uti_amount¶ float: Utility amount-based IBI amount [$]
Required: set to 0 if not provided.
-
ibi_uti_amount_deprbas_fed¶ float: Utility amount-based IBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
ibi_uti_amount_deprbas_sta¶ float: Utility amount-based IBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
ibi_uti_amount_tax_fed¶ float: Utility amount-based IBI federal taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
ibi_uti_amount_tax_sta¶ float: Utility amount-based IBI state taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
ibi_uti_percent¶ float: Utility percentage-based IBI percent [%]
Required: set to 0.0 if not provided.
-
ibi_uti_percent_deprbas_fed¶ float: Utility percentage-based IBI reduces federal depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
ibi_uti_percent_deprbas_sta¶ float: Utility percentage-based IBI reduces state depreciation basis [0/1]
Constraints: BOOLEAN
Required: set to 0 if not provided.
-
ibi_uti_percent_maxvalue¶ float: Utility percentage-based IBI maximum value [$]
Required: set to 1e99 if not provided.
-
ibi_uti_percent_tax_fed¶ float: Utility percentage-based IBI federal taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
ibi_uti_percent_tax_sta¶ float: Utility percentage-based IBI state taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
pbi_fed_amount¶ sequence: Federal PBI amount [$/kWh]
Required: set to 0 if not provided.
-
pbi_fed_escal¶ float: Federal PBI escalation [%]
Required: set to 0 if not provided.
-
pbi_fed_tax_fed¶ float: Federal PBI federal taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
pbi_fed_tax_sta¶ float: Federal PBI state taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
pbi_fed_term¶ float: Federal PBI term [years]
Required: set to 0 if not provided.
-
pbi_oth_amount¶ sequence: Other PBI amount [$/kWh]
Required: set to 0 if not provided.
-
pbi_oth_escal¶ float: Other PBI escalation [%]
Required: set to 0 if not provided.
-
pbi_oth_tax_fed¶ float: Other PBI federal taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
pbi_oth_tax_sta¶ float: Other PBI state taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
pbi_oth_term¶ float: Other PBI term [years]
Required: set to 0 if not provided.
-
pbi_sta_amount¶ sequence: State PBI amount [$/kWh]
Required: set to 0 if not provided.
-
pbi_sta_escal¶ float: State PBI escalation [%]
Required: set to 0 if not provided.
-
pbi_sta_tax_fed¶ float: State PBI federal taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
pbi_sta_tax_sta¶ float: State PBI state taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
pbi_sta_term¶ float: State PBI term [years]
Required: set to 0 if not provided.
-
pbi_uti_amount¶ sequence: Utility PBI amount [$/kWh]
Required: set to 0 if not provided.
-
pbi_uti_escal¶ float: Utility PBI escalation [%]
Required: set to 0 if not provided.
-
pbi_uti_tax_fed¶ float: Utility PBI federal taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
pbi_uti_tax_sta¶ float: Utility PBI state taxable [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
pbi_uti_term¶ float: Utility PBI term [years]
Required: set to 0 if not provided.
-
Battery Group¶
-
class
PySAM.CashloanModel.CashloanModel.Battery¶ -
assign() → None¶ Assign attributes from dictionary
Battery_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
batt_bank_replacement¶ sequence: Battery bank replacements per year [number/year]
-
batt_computed_bank_capacity¶ float: Battery bank capacity [kWh]
Required: set to 0.0 if not provided.
-
batt_replacement_option¶ float: Enable battery replacement? [0=none,1=capacity based,2=user schedule]
Constraints: INTEGER,MIN=0,MAX=2
Required: set to 0 if not provided.
-
batt_replacement_schedule¶ sequence: Battery bank replacements per year (user specified) [number/year]
-
battery_per_kWh¶ float: Battery cost [$/kWh]
Required: set to 0.0 if not provided.
-
en_batt¶ float: Enable battery storage model [0/1]
Required: set to 0 if not provided.
-
FuelCell Group¶
-
class
PySAM.CashloanModel.CashloanModel.FuelCell¶ -
assign() → None¶ Assign attributes from dictionary
FuelCell_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
en_fuelcell¶ float: Enable fuel cell storage model [0/1]
Required: set to 0 if not provided.
-
fuelcell_computed_bank_capacity¶ float: Fuel cell capacity [kWh]
Required: set to 0.0 if not provided.
-
fuelcell_per_kWh¶ float: Fuel cell cost [$/kWh]
Required: set to 0.0 if not provided.
-
fuelcell_replacement¶ sequence: Fuel cell replacements per year [number/year]
-
fuelcell_replacement_option¶ float: Enable fuel cell replacement? [0=none,1=capacity based,2=user schedule]
Constraints: INTEGER,MIN=0,MAX=2
Required: set to 0 if not provided.
-
fuelcell_replacement_schedule¶ sequence: Fuel cell replacements per year (user specified) [number/year]
-
Cashloan Group¶
-
class
PySAM.CashloanModel.CashloanModel.Cashloan¶ -
assign() → None¶ Assign attributes from dictionary
Cashloan_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
annual_energy_value¶ sequence: Energy value [$]
Required: True
-
annual_themal_value¶ sequence: Energy value [$]
-
market¶ float: Residential or Commercial Market [0/1]
Options: 0=residential,1=comm.
Constraints: INTEGER,MIN=0,MAX=1
Required: set to 1 if not provided.
-
mortgage¶ float: Use mortgage style loan (res. only) [0/1]
Options: 0=standard loan,1=mortgage
Constraints: INTEGER,MIN=0,MAX=1
Required: set to 0 if not provided.
-
salvage_percentage¶ float: Salvage value percentage [%]
Constraints: MIN=0,MAX=100
Required: set to 0.0 if not provided.
-
total_installed_cost¶ float: Total installed cost [$]
Constraints: MIN=0
Required: True
-
SystemOutput Group¶
-
class
PySAM.CashloanModel.CashloanModel.SystemOutput¶ -
assign() → None¶ Assign attributes from dictionary
SystemOutput_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
degradation¶ sequence: Annual degradation [%]
Required: True
-
gen¶ sequence: Power generated by renewable resource [kW]
Required: True
-
Lifetime Group¶
-
class
PySAM.CashloanModel.CashloanModel.Lifetime¶ -
assign() → None¶ Assign attributes from dictionary
Lifetime_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
system_use_lifetime_output¶ float: Lifetime hourly system outputs [0/1]
Options: 0=hourly first year,1=hourly lifetime
Constraints: INTEGER,MIN=0
Required: True
-
ThirdPartyOwnership Group¶
-
class
PySAM.CashloanModel.CashloanModel.ThirdPartyOwnership¶ -
assign() → None¶ Assign attributes from dictionary
ThirdPartyOwnership_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
elec_cost_with_system¶ sequence: Energy value [$]
Required: True
-
elec_cost_without_system¶ sequence: Energy value [$]
Required: True
-
Outputs Group¶
-
class
PySAM.CashloanModel.CashloanModel.Outputs¶ -
assign() → None¶ Assign attributes from dictionary
Outputs_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
adjusted_installed_cost¶ float: Net capital cost [$]
-
cbi_total¶ float: Total CBI income [$]
-
cbi_total_fed¶ float: Federal CBI income [$]
-
cbi_total_oth¶ float: Other CBI income [$]
-
cbi_total_sta¶ float: State CBI income [$]
-
cbi_total_uti¶ float: Utility CBI income [$]
-
cf_after_tax_cash_flow¶ sequence: After-tax cash flow [$]
-
cf_after_tax_net_equity_cost_flow¶ sequence: After-tax annual costs [$]
-
cf_battery_replacement_cost¶ sequence: Battery replacement cost [$]
-
cf_battery_replacement_cost_schedule¶ sequence: Battery replacement cost schedule [$/kWh]
-
cf_cumulative_payback_with_expenses¶ sequence: Cumulative simple payback with expenses [$]
-
cf_cumulative_payback_without_expenses¶ sequence: Cumulative simple payback without expenses [$]
-
cf_debt_balance¶ sequence: Debt balance [$]
-
cf_debt_payment_interest¶ sequence: Interest payment [$]
-
cf_debt_payment_principal¶ sequence: Principal payment [$]
-
cf_debt_payment_total¶ sequence: Total P&I debt payment [$]
-
cf_deductible_expenses¶ sequence: Deductible expenses [$]
-
cf_discounted_costs¶ sequence: Discounted costs [$]
-
cf_discounted_cumulative_payback¶ sequence: Cumulative discounted payback [$]
-
cf_discounted_payback¶ sequence: Discounted payback [$]
-
cf_discounted_savings¶ sequence: Discounted savings [$]
-
cf_effective_tax_frac¶ sequence: Effective income tax rate [frac]
-
cf_energy_net¶ sequence: Energy [kWh]
-
cf_energy_value¶ sequence: Value of electricity savings [$]
-
cf_fed_depr_sched¶ sequence: Federal depreciation schedule [%]
-
cf_fed_depreciation¶ sequence: Federal depreciation [$]
-
cf_fed_incentive_income_less_deductions¶ sequence: Federal incentive income less deductions [$]
-
cf_fed_tax_savings¶ sequence: Federal tax savings [$]
-
cf_fed_taxable_income_less_deductions¶ sequence: Federal taxable income less deductions [$]
-
cf_federal_tax_frac¶ sequence: Federal income tax rate [frac]
-
cf_fuelcell_replacement_cost¶ sequence: Fuel cell replacement cost [$]
-
cf_fuelcell_replacement_cost_schedule¶ sequence: Fuel cell replacement cost schedule [$/kW]
-
cf_insurance_expense¶ sequence: Insurance expense [$]
-
cf_length¶ float: Number of periods in cash flow
-
cf_net_salvage_value¶ sequence: Net salvage value [$]
-
cf_nte¶ sequence: Not to exceed (NTE) [cents/kWh]
-
cf_om_capacity1_expense¶ sequence: Battery capacity-based expense [$]
-
cf_om_capacity2_expense¶ sequence: Fuel cell capacity-based expense [$]
-
cf_om_capacity_expense¶ sequence: O&M capacity-based expense [$]
-
cf_om_fixed1_expense¶ sequence: Battery fixed expense [$]
-
cf_om_fixed2_expense¶ sequence: Fuel cell fixed expense [$]
-
cf_om_fixed_expense¶ sequence: O&M fixed expense [$]
-
cf_om_fuel_expense¶ sequence: O&M fuel expense [$]
-
cf_om_opt_fuel_1_expense¶ sequence: O&M biomass feedstock expense [$]
-
cf_om_opt_fuel_2_expense¶ sequence: O&M coal feedstock expense [$]
-
cf_om_production1_expense¶ sequence: Battery production-based expense [$]
-
cf_om_production2_expense¶ sequence: Fuel cell production-based expense [$]
-
cf_om_production_expense¶ sequence: O&M production-based expense [$]
-
cf_operating_expenses¶ sequence: Total operating expense [$]
-
cf_payback_with_expenses¶ sequence: Simple payback with expenses [$]
-
cf_payback_without_expenses¶ sequence: Simple payback without expenses [$]
-
cf_pbi_total¶ sequence: Total PBI income [$]
-
cf_pbi_total_fed¶ sequence: Federal PBI income [$]
-
cf_pbi_total_oth¶ sequence: Other PBI income [$]
-
cf_pbi_total_sta¶ sequence: State PBI income [$]
-
cf_pbi_total_uti¶ sequence: Utility PBI income [$]
-
cf_property_tax_assessed_value¶ sequence: Property tax net assessed value [$]
-
cf_property_tax_expense¶ sequence: Property tax expense [$]
-
cf_ptc_fed¶ sequence: Federal PTC [$]
-
cf_ptc_sta¶ sequence: State PTC [$]
-
cf_ptc_total¶ sequence: Total PTC [$]
-
cf_sta_and_fed_tax_savings¶ sequence: Total tax savings (federal and state) [$]
-
cf_sta_depr_sched¶ sequence: State depreciation schedule [%]
-
cf_sta_depreciation¶ sequence: State depreciation [$]
-
cf_sta_incentive_income_less_deductions¶ sequence: State incentive income less deductions [$]
-
cf_sta_tax_savings¶ sequence: State tax savings [$]
-
cf_sta_taxable_income_less_deductions¶ sequence: State taxable income less deductions [$]
-
cf_state_tax_frac¶ sequence: State income tax rate [frac]
-
cf_thermal_value¶ sequence: Value of thermal savings [$]
-
cf_value_added¶ sequence: Real estate value added [$]
-
discounted_payback¶ float: Discounted payback period [years]
-
effective_tax_rate¶ float: Effective tax rate [%]
-
first_cost¶ float: Equity [$]
-
ibi_total¶ float: Total IBI income [$]
-
ibi_total_fed¶ float: Federal IBI income [$]
-
ibi_total_oth¶ float: Other IBI income [$]
-
ibi_total_sta¶ float: State IBI income [$]
-
ibi_total_uti¶ float: Utility IBI income [$]
-
itc_total¶ float: Total ITC [$]
-
itc_total_fed¶ float: Federal ITC [$]
-
itc_total_sta¶ float: State ITC [$]
-
lcoe_nom¶ float: Nominal LCOE [cents/kWh]
-
lcoe_real¶ float: Real LCOE [cents/kWh]
-
lcoptc_fed_nom¶ float: Levelized federal PTC (nominal) [cents/kWh]
-
lcoptc_fed_real¶ float: Levelized federal PTC (real) [cents/kWh]
-
lcoptc_sta_nom¶ float: Levelized state PTC (nominal) [cents/kWh]
-
lcoptc_sta_real¶ float: Levelized state PTC (real) [cents/kWh]
-
lnte_nom¶ float: Nominal LNTE [cents/kWh]
-
lnte_real¶ float: Real LNTE [cents/kWh]
-
loan_amount¶ float: Debt [$]
-
npv¶ float: Net present value [$]
-
payback¶ float: Payback period [years]
-
present_value_fuel¶ float: Present value of fuel expenses [$]
-
present_value_insandproptax¶ float: Present value of insurance and property tax [$]
-
present_value_oandm¶ float: Present value of O&M expenses [$]
-
present_value_oandm_nonfuel¶ float: Present value of non-fuel O&M expenses [$]
-
total_cost¶ float: Total installed cost [$]
-
wacc¶ float: Weighted average cost of capital (WACC)
-
year1_nte¶ float: Year 1 NTE [cents/kWh]
-