Utilityrate
Utilityrate
- PySAM.Utilityrate.default(config) Utilityrate
Load defaults for the configuration
config. Available configurations are:None
Note
Some inputs do not have default values and may be assigned a value from the variable’s Required attribute. See variable attribute descriptions below.
- PySAM.Utilityrate.from_existing(data, optional config) Utilityrate
Share data with an existing PySAM class. If
optional configis a valid configuration name, load the module’s defaults for that configuration.
- PySAM.Utilityrate.new() Utilityrate
- PySAM.Utilityrate.wrap(ssc_data_t) Utilityrate
Load data from a PySSC object.
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap()
Utilityrate is a wrapper for the SSC compute module cmod_utilityrate.cpp
Interdependent Variables
The variables listed below are interdependent with other variables. If you change the value of one of these variables, you may need to change values of other variables. The SAM user interface manages these interdependent variables, but in PySAM, it is up to you change the value of all interdependent variables so they are consistent. See Interdependent Variables for examples and details.
None
Functions
- class PySAM.Utilityrate.Utilityrate
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 = { 'Common': { var: val, ...}, ...}
- execute(int verbosity) None
Execute simulation with verbosity level 0 (default) or 1
- export() dict
Export attributes into nested dictionary
- get_data_ptr() Pointer
Get ssc_data_t pointer
- replace(dict) None
Replace attributes from nested dictionary, except for Outputs. Unassigns all values in each Group then assigns from the input dict.
nested_dict = { 'Common': { var: val, ...}, ...}
- unassign(name) None
Unassign a value in any of the variable groups.
- value(name, optional value) None | float | dict | sequence | str
Get or set by name a value in any of the variable groups.
Common Group
- class PySAM.Utilityrate.Utilityrate.Common
- assign(dict) None
Assign attributes from dictionary, overwriting but not removing values.
Common_vals = { var: val, ...}
- export() dict
Export attributes into dictionary.
- replace(dict) None
Replace attributes from dictionary, unassigning values not present in input
dict.Common_vals = { var: val, ...}
- analysis_period
Number of years in analysis [years]
Constraints: INTEGER,POSITIVE
Required: True
- Type:
float
- e_with_system
Energy at grid with system [kWh]
Constraints: LENGTH=8760
Required: True
- Type:
sequence
- e_without_system
Energy at grid without system (load only) [kWh]
Constraints: LENGTH=8760
Required: False for configuration with default inputs. May be required if a variable dependent on its value changes. Example: For the Detailed PV - Single Owner configuration, only Subarray 1 is enabled in the configuration defaults, so Subarray 2 inputs would not be required; if Subarray 2 is enabled, then Subarray 2 inputs is required.
- Type:
sequence
- load_escalation
Annual load escalation [%/year]
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
sequence
- p_with_system
Max power at grid with system [kW]
Constraints: LENGTH=8760
Required: False for configuration with default inputs. May be required if a variable dependent on its value changes. Example: For the Detailed PV - Single Owner configuration, only Subarray 1 is enabled in the configuration defaults, so Subarray 2 inputs would not be required; if Subarray 2 is enabled, then Subarray 2 inputs is required.
- Type:
sequence
- p_without_system
Max power at grid without system (load only) [kW]
Constraints: LENGTH=8760
Required: False for configuration with default inputs. May be required if a variable dependent on its value changes. Example: For the Detailed PV - Single Owner configuration, only Subarray 1 is enabled in the configuration defaults, so Subarray 2 inputs would not be required; if Subarray 2 is enabled, then Subarray 2 inputs is required.
- Type:
sequence
- rate_escalation
Annual utility rate escalation [%/year]
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
sequence
- system_availability
Annual availability of system [%/year]
Required: False. Automatically set to 100 if not assigned explicitly or loaded from defaults.
- Type:
sequence
- system_degradation
Annual degradation of system [%/year]
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
sequence
- ur_dc_enable
Enable demand charges [0/1]
Constraints: BOOLEAN
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_fixed_m1
DC fixed rate January [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_fixed_m10
DC fixed rate October [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_fixed_m11
DC fixed rate November [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_fixed_m12
DC fixed rate December [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_fixed_m2
DC fixed rate February [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_fixed_m3
DC fixed rate March [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_fixed_m4
DC fixed rate April [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_fixed_m5
DC fixed rate May [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_fixed_m6
DC fixed rate June [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_fixed_m7
DC fixed rate July [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_fixed_m8
DC fixed rate August [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_fixed_m9
DC fixed rate September [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_p1
DC TOU rate period 1 [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_p2
DC TOU rate period 2 [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_p3
DC TOU rate period 3 [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_p4
DC TOU rate period 4 [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_p5
DC TOU rate period 5 [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_p6
DC TOU rate period 6 [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_p7
DC TOU rate period 7 [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_p8
DC TOU rate period 8 [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_p9
DC TOU rate period 9 [$/kW,pk]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_dc_sched_weekday
DC TOU weekday schedule
Info: 288 digits 0-9, 24x12
Constraints: TOUSCHED
Required: Required if ur_dc_enable=1
- Type:
str
- ur_dc_sched_weekend
DC TOU weekend schedule
Info: 288 digits 0-9, 24x12
Constraints: TOUSCHED
Required: Required if ur_dc_enable=1
- Type:
str
- ur_flat_buy_rate
Flat rate (buy) [$/kWh]
Required: True
- Type:
float
- ur_flat_sell_rate
Flat rate (sell) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_monthly_fixed_charge
Monthly fixed charge [$]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_sell_eq_buy
Force sell rate equal to buy [0/1]
Info: Enforce net metering
Constraints: BOOLEAN
Required: False. Automatically set to 1 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_enable
Enable time-of-use rates [0/1]
Constraints: BOOLEAN
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p1_buy_rate
TOU period 1 rate (buy) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p1_sell_rate
TOU period 1 rate (sell) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p2_buy_rate
TOU period 2 rate (buy) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p2_sell_rate
TOU period 2 rate (sell) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p3_buy_rate
TOU period 3 rate (buy) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p3_sell_rate
TOU period 3 rate (sell) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p4_buy_rate
TOU period 4 rate (buy) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p4_sell_rate
TOU period 4 rate (sell) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p5_buy_rate
TOU period 5 rate (buy) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p5_sell_rate
TOU period 5 rate (sell) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p6_buy_rate
TOU period 6 rate (buy) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p6_sell_rate
TOU period 6 rate (sell) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p7_buy_rate
TOU period 7 rate (buy) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p7_sell_rate
TOU period 7 rate (sell) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p8_buy_rate
TOU period 8 rate (buy) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p8_sell_rate
TOU period 8 rate (sell) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p9_buy_rate
TOU period 9 rate (buy) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_p9_sell_rate
TOU period 9 rate (sell) [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tou_sched_weekday
TOU weekday schedule
Info: 288 digits 0-9, 24x12
Constraints: TOUSCHED
Required: Required if ur_tou_enable=1
- Type:
str
- ur_tou_sched_weekend
TOU weekend schedule
Info: 288 digits 0-9, 24x12
Constraints: TOUSCHED
Required: Required if ur_tou_enable=1
- Type:
str
- ur_tr_enable
Enable tiered rates [0/1]
Constraints: BOOLEAN
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s1_energy_ub1
Tiered struct. 1 Energy UB 1 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s1_energy_ub2
Tiered struct. 1 Energy UB 2 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s1_energy_ub3
Tiered struct. 1 Energy UB 3 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s1_energy_ub4
Tiered struct. 1 Energy UB 4 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s1_energy_ub5
Tiered struct. 1 Energy UB 5 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s1_energy_ub6
Tiered struct. 1 Energy UB 6 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s1_rate1
Tiered struct. 1 Rate 1 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s1_rate2
Tiered struct. 1 Rate 2 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s1_rate3
Tiered struct. 1 Rate 3 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s1_rate4
Tiered struct. 1 Rate 4 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s1_rate5
Tiered struct. 1 Rate 5 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s1_rate6
Tiered struct. 1 Rate 6 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s2_energy_ub1
Tiered struct. 2 Energy UB 1 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s2_energy_ub2
Tiered struct. 2 Energy UB 2 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s2_energy_ub3
Tiered struct. 2 Energy UB 3 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s2_energy_ub4
Tiered struct. 2 Energy UB 4 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s2_energy_ub5
Tiered struct. 2 Energy UB 5 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s2_energy_ub6
Tiered struct. 2 Energy UB 6 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s2_rate1
Tiered struct. 2 Rate 1 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s2_rate2
Tiered struct. 2 Rate 2 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s2_rate3
Tiered struct. 2 Rate 3 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s2_rate4
Tiered struct. 2 Rate 4 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s2_rate5
Tiered struct. 2 Rate 5 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s2_rate6
Tiered struct. 2 Rate 6 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s3_energy_ub1
Tiered struct. 3 Energy UB 1 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s3_energy_ub2
Tiered struct. 3 Energy UB 2 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s3_energy_ub3
Tiered struct. 3 Energy UB 3 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s3_energy_ub4
Tiered struct. 3 Energy UB 4 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s3_energy_ub5
Tiered struct. 3 Energy UB 5 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s3_energy_ub6
Tiered struct. 3 Energy UB 6 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s3_rate1
Tiered struct. 3 Rate 1 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s3_rate2
Tiered struct. 3 Rate 2 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s3_rate3
Tiered struct. 3 Rate 3 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s3_rate4
Tiered struct. 3 Rate 4 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s3_rate5
Tiered struct. 3 Rate 5 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s3_rate6
Tiered struct. 3 Rate 6 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s4_energy_ub1
Tiered struct. 4 Energy UB 1 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s4_energy_ub2
Tiered struct. 4 Energy UB 2 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s4_energy_ub3
Tiered struct. 4 Energy UB 3 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s4_energy_ub4
Tiered struct. 4 Energy UB 4 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s4_energy_ub5
Tiered struct. 4 Energy UB 5 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s4_energy_ub6
Tiered struct. 4 Energy UB 6 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s4_rate1
Tiered struct. 4 Rate 1 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s4_rate2
Tiered struct. 4 Rate 2 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s4_rate3
Tiered struct. 4 Rate 3 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s4_rate4
Tiered struct. 4 Rate 4 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s4_rate5
Tiered struct. 4 Rate 5 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s4_rate6
Tiered struct. 4 Rate 6 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s5_energy_ub1
Tiered struct. 5 Energy UB 1 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s5_energy_ub2
Tiered struct. 5 Energy UB 2 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s5_energy_ub3
Tiered struct. 5 Energy UB 3 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s5_energy_ub4
Tiered struct. 5 Energy UB 4 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s5_energy_ub5
Tiered struct. 5 Energy UB 5 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s5_energy_ub6
Tiered struct. 5 Energy UB 6 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s5_rate1
Tiered struct. 5 Rate 1 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s5_rate2
Tiered struct. 5 Rate 2 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s5_rate3
Tiered struct. 5 Rate 3 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s5_rate4
Tiered struct. 5 Rate 4 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s5_rate5
Tiered struct. 5 Rate 5 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s5_rate6
Tiered struct. 5 Rate 6 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s6_energy_ub1
Tiered struct. 6 Energy UB 1 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s6_energy_ub2
Tiered struct. 6 Energy UB 2 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s6_energy_ub3
Tiered struct. 6 Energy UB 3 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s6_energy_ub4
Tiered struct. 6 Energy UB 4 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s6_energy_ub5
Tiered struct. 6 Energy UB 5 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s6_energy_ub6
Tiered struct. 6 Energy UB 6 [kWh]
Required: False. Automatically set to 1e99 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s6_rate1
Tiered struct. 6 Rate 1 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s6_rate2
Tiered struct. 6 Rate 2 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s6_rate3
Tiered struct. 6 Rate 3 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s6_rate4
Tiered struct. 6 Rate 4 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s6_rate5
Tiered struct. 6 Rate 5 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_s6_rate6
Tiered struct. 6 Rate 6 [$/kWh]
Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_sched_m1
Tiered structure for January [0-5]
Info: tiered structure #
Constraints: INTEGER,MIN=0,MAX=5
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_sched_m10
Tiered structure for October [0-5]
Info: tiered structure #
Constraints: INTEGER,MIN=0,MAX=5
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_sched_m11
Tiered structure for November [0-5]
Info: tiered structure #
Constraints: INTEGER,MIN=0,MAX=5
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_sched_m12
Tiered structure for December [0-5]
Info: tiered structure #
Constraints: INTEGER,MIN=0,MAX=5
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_sched_m2
Tiered structure for February [0-5]
Info: tiered structure #
Constraints: INTEGER,MIN=0,MAX=5
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_sched_m3
Tiered structure for March [0-5]
Info: tiered structure #
Constraints: INTEGER,MIN=0,MAX=5
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_sched_m4
Tiered structure for April [0-5]
Info: tiered structure #
Constraints: INTEGER,MIN=0,MAX=5
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_sched_m5
Tiered structure for May [0-5]
Info: tiered structure #
Constraints: INTEGER,MIN=0,MAX=5
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_sched_m6
Tiered structure for June [0-5]
Info: tiered structure #
Constraints: INTEGER,MIN=0,MAX=5
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_sched_m7
Tiered structure for July [0-5]
Info: tiered structure #
Constraints: INTEGER,MIN=0,MAX=5
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_sched_m8
Tiered structure for August [0-5]
Info: tiered structure #
Constraints: INTEGER,MIN=0,MAX=5
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_sched_m9
Tiered structure for September [0-5]
Info: tiered structure #
Constraints: INTEGER,MIN=0,MAX=5
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_sell_mode
Tiered rate sell mode [0,1,2]
Options: 0=specified,1=tier1,2=lowest
Constraints: INTEGER,MIN=0,MAX=2
Required: False. Automatically set to 1 if not assigned explicitly or loaded from defaults.
- Type:
float
- ur_tr_sell_rate
Specified tiered sell rate [$/kW]
Required: Required if ur_tr_sell_mode=0
- Type:
float
Outputs Group
- class PySAM.Utilityrate.Utilityrate.Outputs
- assign(dict) None
Assign attributes from dictionary, overwriting but not removing values.
Outputs_vals = { var: val, ...}
- export() dict
Export attributes into dictionary.
- replace(dict) None
Replace attributes from dictionary, unassigning values not present in input
dict.Outputs_vals = { var: val, ...}
- charge_dc_fixed_apr
Demand charge (fixed) in Apr [$]
- Type:
sequence
- charge_dc_fixed_aug
Demand charge (fixed) in Aug [$]
- Type:
sequence
- charge_dc_fixed_dec
Demand charge (fixed) in Dec [$]
- Type:
sequence
- charge_dc_fixed_feb
Demand charge (fixed) in Feb [$]
- Type:
sequence
- charge_dc_fixed_jan
Demand charge (fixed) in Jan [$]
- Type:
sequence
- charge_dc_fixed_jul
Demand charge (fixed) in Jul [$]
- Type:
sequence
- charge_dc_fixed_jun
Demand charge (fixed) in Jun [$]
- Type:
sequence
- charge_dc_fixed_mar
Demand charge (fixed) in Mar [$]
- Type:
sequence
- charge_dc_fixed_may
Demand charge (fixed) in May [$]
- Type:
sequence
- charge_dc_fixed_nov
Demand charge (fixed) in Nov [$]
- Type:
sequence
- charge_dc_fixed_oct
Demand charge (fixed) in Oct [$]
- Type:
sequence
- charge_dc_fixed_sep
Demand charge (fixed) in Sep [$]
- Type:
sequence
- charge_dc_tou_apr
Demand charge (TOU) in Apr [$]
- Type:
sequence
- charge_dc_tou_aug
Demand charge (TOU) in Aug [$]
- Type:
sequence
- charge_dc_tou_dec
Demand charge (TOU) in Dec [$]
- Type:
sequence
- charge_dc_tou_feb
Demand charge (TOU) in Feb [$]
- Type:
sequence
- charge_dc_tou_jan
Demand charge (TOU) in Jan [$]
- Type:
sequence
- charge_dc_tou_jul
Demand charge (TOU) in Jul [$]
- Type:
sequence
- charge_dc_tou_jun
Demand charge (TOU) in Jun [$]
- Type:
sequence
- charge_dc_tou_mar
Demand charge (TOU) in Mar [$]
- Type:
sequence
- charge_dc_tou_may
Demand charge (TOU) in May [$]
- Type:
sequence
- charge_dc_tou_nov
Demand charge (TOU) in Nov [$]
- Type:
sequence
- charge_dc_tou_oct
Demand charge (TOU) in Oct [$]
- Type:
sequence
- charge_dc_tou_sep
Demand charge (TOU) in Sep [$]
- Type:
sequence
- charge_tr_apr
Tiered rate charge in Apr [$]
- Type:
sequence
- charge_tr_aug
Tiered rate charge in Aug [$]
- Type:
sequence
- charge_tr_dec
Tiered rate charge in Dec [$]
- Type:
sequence
- charge_tr_feb
Tiered rate charge in Feb [$]
- Type:
sequence
- charge_tr_jan
Tiered rate charge in Jan [$]
- Type:
sequence
- charge_tr_jul
Tiered rate charge in Jul [$]
- Type:
sequence
- charge_tr_jun
Tiered rate charge in Jun [$]
- Type:
sequence
- charge_tr_mar
Tiered rate charge in Mar [$]
- Type:
sequence
- charge_tr_may
Tiered rate charge in May [$]
- Type:
sequence
- charge_tr_nov
Tiered rate charge in Nov [$]
- Type:
sequence
- charge_tr_oct
Tiered rate charge in Oct [$]
- Type:
sequence
- charge_tr_sep
Tiered rate charge in Sep [$]
- Type:
sequence
- elec_cost_with_system
Electricity cost with system [$/yr]
- Type:
sequence
- elec_cost_without_system
Electricity cost without system [$/yr]
- Type:
sequence
- energy_net
Energy by each year [kW]
- Type:
sequence
- energy_value
Energy value by each year [$]
- Type:
sequence
- revenue_with_system
Total revenue with system [$]
- Type:
sequence
- revenue_without_system
Total revenue without system [$]
- Type:
sequence
- year1_hourly_e_demand
Electricity from grid [kWh]
- Type:
sequence
- year1_hourly_e_grid
Electricity at grid [kWh]
- Type:
sequence
- year1_hourly_income_with_system
Income with system [$]
- Type:
sequence
- year1_hourly_income_without_system
Income without system [$]
- Type:
sequence
- year1_hourly_p_demand
Peak from grid [kW]
- Type:
sequence
- year1_hourly_p_grid
Peak at grid [kW]
- Type:
sequence
- year1_hourly_p_system_to_load
Peak to load [kW]
- Type:
sequence
- year1_hourly_payment_with_system
Payment with system [$]
- Type:
sequence
- year1_hourly_payment_without_system
Payment without system [$]
- Type:
sequence
- year1_hourly_price_with_system
Price with system [$]
- Type:
sequence
- year1_hourly_price_without_system
Price without system [$]
- Type:
sequence
- year1_hourly_revenue_with_system
Revenue with system [$]
- Type:
sequence
- year1_hourly_revenue_without_system
Revenue without system [$]
- Type:
sequence
- year1_hourly_system_output
Electricity from system [kWh]
- Type:
sequence
- year1_hourly_system_to_grid
Electricity to grid [kWh]
- Type:
sequence
- year1_hourly_system_to_load
Electricity to load [kWh]
- Type:
sequence
- year1_monthly_dc_fixed_with_system
Demand charge (fixed) with system [$]
- Type:
sequence
- year1_monthly_dc_fixed_without_system
Demand charge (fixed) without system [$]
- Type:
sequence
- year1_monthly_dc_tou_with_system
Demand charge (TOU) with system [$]
- Type:
sequence
- year1_monthly_dc_tou_without_system
Demand charge (TOU) without system [$]
- Type:
sequence
- year1_monthly_tr_charge_with_system
Tiered charge with system [$]
- Type:
sequence
- year1_monthly_tr_charge_without_system
Tiered charge without system [$]
- Type:
sequence
- year1_monthly_tr_rate_with_system
Tiered rate with system [$]
- Type:
sequence
- year1_monthly_tr_rate_without_system
Tiered rate without system [$]
- Type:
sequence