Cashloan¶
Wrapper for SAM Simulation Core model: cmod_cashloan.cpp
Input Consistency Warning¶
As described in Possible Problems, some input parameters are interdependent but the equations that enforce consistency are not available in this PySAM module. Therefore, the onus is on the PySAM user to check that interdependencies are correctly handled. The variables which may require additional logic include:
Provided for each of these inputs is a list of other inputs that are potentially interdependent.
Creating an Instance¶
Refer to the Initializing a Model page for details on the different ways to create an instance of a PySAM class.
Cashloan model description
Cashloan
-
PySAM.Cashloan.default(config) → Cashloan¶ Use default attributes config options:
- “DSLFCommercial”
- “EmpiricalTroughCommercial”
- “FlatPlatePVCommercial”
- “FlatPlatePVResidential”
- “FuelCellCommercial”
- “GenericBatteryCommercial”
- “GenericBatteryResidential”
- “GenericCSPSystemCommercial”
- “GenericSystemCommercial”
- “GenericSystemResidential”
- “MSLFCommercial”
- “PVBatteryCommercial”
- “PVBatteryResidential”
- “PVWattsBatteryCommercial”
- “PVWattsBatteryResidential”
- “PVWattsCommercial”
- “PVWattsResidential”
- “PhysicalTroughCommercial”
- “SolarWaterHeatingCommercial”
- “SolarWaterHeatingResidential”
- “WindPowerCommercial”
- “WindPowerResidential”
-
PySAM.Cashloan.from_existing(data, optional config) → Cashloan¶ Share underlying data with an existing PySAM class. If config provided, default attributes are loaded otherwise.
-
PySAM.Cashloan.new() → Cashloan¶
-
PySAM.Cashloan.wrap(ssc_data_t) → Cashloan¶ Use existing PySSC data
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap
Functions¶
-
class
PySAM.Cashloan.Cashloan¶ 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
-
unassign(name) → None¶ Unassign a value in any of the variable groups.
-
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.Cashloan.Cashloan.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
-
market¶ Residential or Commercial Market [0/1]
Options: 0=residential,1=comm.
Constraints: INTEGER,MIN=0,MAX=1
Required: If not provided, assumed to be 1
Type: float
-
mortgage¶ Use mortgage style loan (res. only) [0/1]
Options: 0=standard loan,1=mortgage
Constraints: INTEGER,MIN=0,MAX=1
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
-
salvage_percentage¶ Salvage value percentage [%]
Constraints: MIN=0,MAX=100
Required: If not provided, assumed to be 0.0
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.Cashloan.Cashloan.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
-
total_installed_cost¶ Total installed cost [$]
Constraints: MIN=0
Required: True
Type: float
-
Depreciation Group¶
-
class
PySAM.Cashloan.Cashloan.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.Cashloan.Cashloan.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.Cashloan.Cashloan.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
-
BatterySystem Group¶
-
class
PySAM.Cashloan.Cashloan.BatterySystem¶ -
assign() → None¶ Assign attributes from dictionary
BatterySystem_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
batt_bank_replacement¶ Battery bank replacements per year [number/year]
Type: sequence
-
batt_computed_bank_capacity¶ Battery bank capacity [kWh]
Required: If not provided, assumed to be 0.0
Type: float
-
batt_replacement_option¶ Enable battery replacement? [0=none,1=capacity based,2=user schedule]
Constraints: INTEGER,MIN=0,MAX=2
Required: If not provided, assumed to be 0
Type: float
-
batt_replacement_schedule_percent¶ Percentage of battery capacity to replace in each year [%]
Options: length <= analysis_period
Type: sequence
-
battery_per_kWh¶ Battery cost [$/kWh]
Required: If not provided, assumed to be 0.0
Type: float
-
en_batt¶ Enable battery storage model [0/1]
Required: If not provided, assumed to be 0
Type: float
-
FuelCell Group¶
-
class
PySAM.Cashloan.Cashloan.FuelCell¶ -
assign() → None¶ Assign attributes from dictionary
FuelCell_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
en_fuelcell¶ Enable fuel cell storage model [0/1]
Required: If not provided, assumed to be 0
Type: float
-
fuelcell_computed_bank_capacity¶ Fuel cell capacity [kWh]
Required: If not provided, assumed to be 0.0
Type: float
-
fuelcell_per_kWh¶ Fuel cell cost [$/kWh]
Required: If not provided, assumed to be 0.0
Type: float
-
fuelcell_replacement¶ Fuel cell replacements per year [number/year]
Type: sequence
-
fuelcell_replacement_option¶ Enable fuel cell replacement? [0=none,1=capacity based,2=user schedule]
Constraints: INTEGER,MIN=0,MAX=2
Required: If not provided, assumed to be 0
Type: float
-
fuelcell_replacement_schedule¶ Fuel cell replacements per year (user specified) [number/year]
Type: sequence
-
SystemOutput Group¶
-
class
PySAM.Cashloan.Cashloan.SystemOutput¶ -
assign() → None¶ Assign attributes from dictionary
SystemOutput_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
annual_energy_value¶ Energy value [$]
Required: True
Type: sequence
-
annual_themal_value¶ Energy value [$]
Type: sequence
-
degradation¶ Annual degradation [%]
Required: True
Type: sequence
-
gen¶ Power generated by renewable resource [kW]
Required: True
Type: sequence
-
Lifetime Group¶
-
class
PySAM.Cashloan.Cashloan.Lifetime¶ -
assign() → None¶ Assign attributes from dictionary
Lifetime_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
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
-
ThirdPartyOwnership Group¶
-
class
PySAM.Cashloan.Cashloan.ThirdPartyOwnership¶ -
assign() → None¶ Assign attributes from dictionary
ThirdPartyOwnership_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
elec_cost_with_system¶ Energy value [$]
Required: True
Type: sequence
-
elec_cost_without_system¶ Energy value [$]
Required: True
Type: sequence
-
Outputs Group¶
-
class
PySAM.Cashloan.Cashloan.Outputs¶ -
assign() → None¶ Assign attributes from dictionary
Outputs_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
adjusted_installed_cost¶ Net capital cost [$]
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_cost_flow¶ After-tax annual costs [$]
Type: sequence
-
cf_battery_replacement_cost¶ Battery replacement cost [$]
Type: sequence
-
cf_battery_replacement_cost_schedule¶ Battery replacement cost schedule [$]
Type: sequence
-
cf_cumulative_payback_with_expenses¶ Cumulative simple payback with expenses [$]
Type: sequence
-
cf_cumulative_payback_without_expenses¶ Cumulative simple payback without expenses [$]
Type: sequence
-
cf_debt_balance¶ Debt balance [$]
Type: sequence
-
cf_debt_payment_interest¶ Interest payment [$]
Type: sequence
-
cf_debt_payment_principal¶ Principal payment [$]
Type: sequence
-
cf_debt_payment_total¶ Total P&I debt payment [$]
Type: sequence
-
cf_deductible_expenses¶ Deductible expenses [$]
Type: sequence
-
cf_discounted_costs¶ Discounted costs [$]
Type: sequence
-
cf_discounted_cumulative_payback¶ Cumulative discounted payback [$]
Type: sequence
-
cf_discounted_payback¶ Discounted payback [$]
Type: sequence
-
cf_discounted_savings¶ Discounted savings [$]
Type: sequence
-
cf_effective_tax_frac¶ Effective income tax rate [frac]
Type: sequence
-
cf_energy_net¶ Energy [kWh]
Type: sequence
-
cf_energy_value¶ Value of electricity savings [$]
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_tax_savings¶ Federal tax savings [$]
Type: sequence
-
cf_fed_taxable_incentive_income¶ Federal taxable incentive income [$]
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_fuelcell_replacement_cost¶ Fuel cell replacement cost [$]
Type: sequence
-
cf_fuelcell_replacement_cost_schedule¶ Fuel cell replacement cost schedule [$/kW]
Type: sequence
-
cf_insurance_expense¶ Insurance expense [$]
Type: sequence
-
cf_length¶ Number of periods in cash flow
Type: float
-
cf_net_salvage_value¶ Net salvage value [$]
Type: sequence
-
cf_nte¶ Not to exceed (NTE) [cents/kWh]
Type: sequence
-
cf_om_capacity1_expense¶ Battery capacity-based expense [$]
Type: sequence
-
cf_om_capacity2_expense¶ Fuel cell capacity-based expense [$]
Type: sequence
-
cf_om_capacity_expense¶ O&M capacity-based expense [$]
Type: sequence
-
cf_om_fixed1_expense¶ Battery fixed expense [$]
Type: sequence
-
cf_om_fixed2_expense¶ Fuel cell fixed 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_production1_expense¶ Battery production-based expense [$]
Type: sequence
-
cf_om_production2_expense¶ Fuel cell production-based expense [$]
Type: sequence
-
cf_om_production_expense¶ O&M production-based expense [$]
Type: sequence
-
cf_operating_expenses¶ Total operating expense [$]
Type: sequence
-
cf_payback_with_expenses¶ Simple payback with expenses [$]
Type: sequence
-
cf_payback_without_expenses¶ Simple payback without expenses [$]
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_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_sta_and_fed_tax_savings¶ Total tax savings (federal and 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_tax_savings¶ State tax savings [$]
Type: sequence
-
cf_sta_taxable_incentive_income¶ State taxable incentive income [$]
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
-
cf_thermal_value¶ Value of thermal savings [$]
Type: sequence
-
cf_value_added¶ Real estate value added [$]
Type: sequence
-
discounted_payback¶ Discounted payback period [years]
Type: float
-
effective_tax_rate¶ Effective tax rate [%]
Type: float
-
first_cost¶ Equity [$]
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
-
itc_total¶ Total ITC income [$]
Type: float
-
itc_total_fed¶ Federal ITC income [$]
Type: float
-
itc_total_sta¶ State ITC income [$]
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
-
lnte_nom¶ Nominal LNTE [cents/kWh]
Type: float
-
lnte_real¶ Real LNTE [cents/kWh]
Type: float
-
loan_amount¶ Debt [$]
Type: float
-
npv¶ Net present value [$]
Type: float
-
payback¶ Payback period [years]
Type: float
-
present_value_fuel¶ Present value of fuel expenses [$]
Type: float
-
present_value_insandproptax¶ Present value of insurance and property tax [$]
Type: float
-
present_value_oandm¶ Present value of O&M expenses [$]
Type: float
-
present_value_oandm_nonfuel¶ Present value of non-fuel O&M expenses [$]
Type: float
-
total_cost¶ Total installed cost [$]
Type: float
-
wacc¶ Weighted average cost of capital (WACC)
Type: float
-
year1_nte¶ Year 1 NTE [cents/kWh]
Type: float
-