SAM Simulation Core (SSC) Release Notes

The following is a list of changes to SSC variables for programmers using the SAM Software Development Kit (SDK), including the PySAM Python package. If you have a question about these release notes, please post it on the SAM SDK forum.

Additional references:

SSC Version 267 (SAM version 2021.12.02, PySAM version 3.0.0)

List of variables whose definition changed in SSC 267

Battery

Refactor the battery dispatch options such that forecast and dispatch algorithm are seperate options. New options for batt_dispatch_choice are:

Forecast is now controlled by new variables batt_dispatch_wf_forecast_choice and batt_dispatch_load_forecast_choice:

Variables for new behind-the-meter dispatch and power flow calculations:

Variables for new grid outage calculations:

New option to enable standalone battery:

BatteryStateful

New cycle_counts variable, a 2xn matrix used for rainflow counting when batt_life is set to 0.

UtilityRate5

Front-of-meter financial models (Equpartflip, Levpartflip, Merchantplant, Saleleasback, Singleowner) now use the utility rate module to calculate grid charging and parastics costs.

The following variable names have been changed:

The new variable ur_dc_billing_demand_periods specifies the demand charge periods used to calculate billing demand.

List of variables that have been added or removed for SSC 267

Model Variables
Battery Added:
  • batt_Vcut
  • batt_dispatch_auto_btm_can_discharge_to_grid
  • batt_dispatch_charge_only_system_exceeds_load
  • batt_dispatch_discharge_only_load_exceeds_system
  • batt_dispatch_load_forecast_choice
  • batt_dispatch_pvs_ac_lb
  • batt_dispatch_pvs_ac_lb_enable
  • batt_dispatch_pvs_ac_ub
  • batt_dispatch_pvs_ac_ub_enable
  • batt_dispatch_pvs_curtail_as_control
  • batt_dispatch_pvs_curtail_if_violation
  • batt_dispatch_pvs_forecast_shift_periods
  • batt_dispatch_pvs_kf
  • batt_dispatch_pvs_ki
  • batt_dispatch_pvs_kp
  • batt_dispatch_pvs_max_ramp
  • batt_dispatch_pvs_nameplate_ac
  • batt_dispatch_pvs_short_forecast_enable
  • batt_dispatch_pvs_soc_rest
  • batt_dispatch_pvs_timestep_multiplier
  • batt_dispatch_wf_forecast_choice
  • batt_load_ac_forecast
  • batt_load_ac_forecast_escalation
  • batt_minimum_outage_SOC
  • crit_load_escalation
  • dispatch_manual_btm_discharge_to_grid
  • en_standalone_batt
  • enable_interconnection_limit
  • grid_curtailment
  • grid_interconnection_limit_kwac
  • grid_outage
  • om_batt_replacement_cost
  • om_replacement_cost_escal
  • run_resiliency_calcs
  • ur_billing_demand_lookback_percentages
  • ur_billing_demand_lookback_period
  • ur_billing_demand_minimum
  • ur_dc_billing_demand_periods
  • ur_enable_billing_demand
  • ur_yearzero_usage_peaks
Removed:
  • batt_auto_gridcharge_max_daily
BatteryStateful Added:
  • DOD_max
  • DOD_min
  • EFC
  • EFC_dt
  • Vcut
  • b1_dt
  • b2_dt
  • b3_dt
  • c0_dt
  • c2_dt
  • cum_dt
  • cycle_DOD
  • cycle_DOD_max
  • cycle_DOD_range
  • cycle_counts
  • cycle_range
  • dq_relative_cal
  • dq_relative_cyc
  • dq_relative_li1
  • dq_relative_li2
  • dq_relative_li3
  • dq_relative_neg
  • q_relative_li
  • q_relative_neg
  • temp_avg
Removed:
  • range
Battwatts Added:
  • enable_interconnection_limit
  • grid_curtailment
  • grid_interconnection_limit_kwac
  • grid_outage
  • run_resiliency_calcs
Cashloan Added:
  • batt_annual_charge_energy
  • batt_annual_charge_from_system
  • batt_annual_discharge_energy
  • batt_capacity_percent
  • batt_salvage_percentage
  • battery_total_cost_lcos
  • charge_w_sys_dc_tou_ym
  • charge_w_sys_ec_ym
  • charge_w_sys_fixed_ym
  • en_standalone_batt
  • fuelcell_annual_energy_discharged
  • gen_purchases
  • grid_to_batt
  • land_area
  • monthly_batt_to_grid
  • monthly_grid_to_batt
  • monthly_grid_to_load
  • monthly_system_to_grid
  • net_billing_credits_ym
  • nm_dollars_applied_ym
  • om_batt_capacity_cost
  • om_batt_fixed_cost
  • om_batt_nameplate
  • om_batt_replacement_cost
  • om_batt_variable_cost
  • om_fuelcell_capacity_cost
  • om_fuelcell_fixed_cost
  • om_fuelcell_nameplate
  • om_fuelcell_replacement_cost
  • om_fuelcell_variable_cost
  • om_land_lease
  • om_land_lease_escal
  • true_up_credits_ym
  • utility_bill_w_sys
  • year1_hourly_dc_with_system
  • year1_hourly_e_fromgrid
  • year1_hourly_ec_with_system
  • year1_monthly_ec_charge_gross_with_system
  • year1_monthly_ec_charge_with_system
  • year1_monthly_electricity_to_grid
Removed:
  • om_capacity1
  • om_capacity1_nameplate
  • om_capacity2
  • om_capacity2_nameplate
  • om_fixed1
  • om_fixed2
  • om_production1
  • om_production2
  • om_replacement_cost1
  • om_replacement_cost2
Equpartflip Added:
  • batt_annual_charge_energy
  • batt_annual_charge_from_system
  • batt_annual_discharge_energy
  • batt_capacity_percent
  • batt_salvage_percentage
  • battery_total_cost_lcos
  • charge_w_sys_ec_ym
  • en_electricity_rates
  • en_standalone_batt
  • fuelcell_annual_energy_discharged
  • gen_purchases
  • grid_to_batt
  • land_area
  • monthly_batt_to_grid
  • monthly_grid_to_batt
  • monthly_grid_to_load
  • monthly_system_to_grid
  • net_billing_credits_ym
  • nm_dollars_applied_ym
  • om_batt_capacity_cost
  • om_batt_fixed_cost
  • om_batt_nameplate
  • om_batt_replacement_cost
  • om_batt_variable_cost
  • om_fuelcell_capacity_cost
  • om_fuelcell_fixed_cost
  • om_fuelcell_nameplate
  • om_fuelcell_replacement_cost
  • om_fuelcell_variable_cost
  • om_land_lease
  • om_land_lease_escal
  • true_up_credits_ym
  • utility_bill_w_sys
  • year1_monthly_ec_charge_gross_with_system
  • year1_monthly_ec_charge_with_system
  • year1_monthly_electricity_to_grid
Removed:
  • om_capacity1
  • om_capacity1_nameplate
  • om_capacity2
  • om_capacity2_nameplate
  • om_fixed1
  • om_fixed2
  • om_production1
  • om_production2
  • om_replacement_cost1
  • om_replacement_cost2
Geothermal Added:
  • dt_prod_well
Grid Added:
  • crit_load
  • grid_outage
HostDeveloper Added:
  • batt_annual_charge_energy
  • batt_annual_charge_from_system
  • batt_annual_discharge_energy
  • batt_capacity_percent
  • batt_salvage_percentage
  • battery_total_cost_lcos
  • charge_w_sys_ec_ym
  • charge_w_sys_fixed_ym
  • dscr_limit_debt_fraction
  • dscr_maximum_debt_fraction
  • en_standalone_batt
  • fuelcell_annual_energy_discharged
  • gen_purchases
  • grid_to_batt
  • land_area
  • monthly_batt_to_grid
  • monthly_grid_to_batt
  • monthly_grid_to_load
  • monthly_system_to_grid
  • net_billing_credits_ym
  • nm_dollars_applied_ym
  • om_batt_capacity_cost
  • om_batt_fixed_cost
  • om_batt_nameplate
  • om_batt_replacement_cost
  • om_batt_variable_cost
  • om_fuelcell_capacity_cost
  • om_fuelcell_fixed_cost
  • om_fuelcell_nameplate
  • om_fuelcell_replacement_cost
  • om_fuelcell_variable_cost
  • om_land_lease
  • om_land_lease_escal
  • true_up_credits_ym
  • year1_hourly_dc_with_system
  • year1_hourly_e_fromgrid
  • year1_hourly_ec_with_system
  • year1_monthly_ec_charge_gross_with_system
  • year1_monthly_ec_charge_with_system
  • year1_monthly_electricity_to_grid
Removed:
  • gen
  • om_capacity1
  • om_capacity1_nameplate
  • om_capacity2
  • om_capacity2_nameplate
  • om_fixed1
  • om_fixed2
  • om_production1
  • om_production2
  • om_replacement_cost1
  • om_replacement_cost2
  • roe_input
Ippppa Added:
  • fuelcell_annual_energy_discharged
  • land_area
  • om_batt_capacity_cost
  • om_batt_fixed_cost
  • om_batt_nameplate
  • om_batt_replacement_cost
  • om_batt_variable_cost
  • om_fuelcell_capacity_cost
  • om_fuelcell_fixed_cost
  • om_fuelcell_nameplate
  • om_fuelcell_replacement_cost
  • om_fuelcell_variable_cost
  • om_land_lease
  • om_land_lease_escal
Removed:
  • om_capacity1
  • om_capacity1_nameplate
  • om_capacity2
  • om_capacity2_nameplate
  • om_fixed1
  • om_fixed2
  • om_production1
  • om_production2
  • om_replacement_cost1
  • om_replacement_cost2
Irradproc Added:
  • diff
  • glob
  • slope_azm
  • slope_tilt
Removed:
  • diffuse
  • global
Levpartflip Added:
  • batt_annual_charge_energy
  • batt_annual_charge_from_system
  • batt_annual_discharge_energy
  • batt_capacity_percent
  • batt_salvage_percentage
  • battery_total_cost_lcos
  • charge_w_sys_ec_ym
  • dscr_limit_debt_fraction
  • dscr_maximum_debt_fraction
  • en_electricity_rates
  • en_standalone_batt
  • fuelcell_annual_energy_discharged
  • gen_purchases
  • grid_to_batt
  • land_area
  • monthly_batt_to_grid
  • monthly_grid_to_batt
  • monthly_grid_to_load
  • monthly_system_to_grid
  • net_billing_credits_ym
  • nm_dollars_applied_ym
  • om_batt_capacity_cost
  • om_batt_fixed_cost
  • om_batt_nameplate
  • om_batt_replacement_cost
  • om_batt_variable_cost
  • om_fuelcell_capacity_cost
  • om_fuelcell_fixed_cost
  • om_fuelcell_nameplate
  • om_fuelcell_replacement_cost
  • om_fuelcell_variable_cost
  • om_land_lease
  • om_land_lease_escal
  • true_up_credits_ym
  • utility_bill_w_sys
  • year1_monthly_ec_charge_gross_with_system
  • year1_monthly_ec_charge_with_system
  • year1_monthly_electricity_to_grid
Removed:
  • om_capacity1
  • om_capacity1_nameplate
  • om_capacity2
  • om_capacity2_nameplate
  • om_fixed1
  • om_fixed2
  • om_production1
  • om_production2
  • om_replacement_cost1
  • om_replacement_cost2
Merchantplant Added:
  • batt_annual_charge_energy
  • batt_annual_charge_from_system
  • batt_annual_discharge_energy
  • batt_capacity_percent
  • batt_salvage_percentage
  • battery_total_cost_lcos
  • charge_w_sys_ec_ym
  • dscr_limit_debt_fraction
  • dscr_maximum_debt_fraction
  • en_electricity_rates
  • en_standalone_batt
  • fuelcell_annual_energy_discharged
  • gen_purchases
  • land_area
  • monthly_batt_to_grid
  • monthly_grid_to_batt
  • monthly_grid_to_load
  • monthly_system_to_grid
  • mp_ancserv1_percent_gen
  • mp_ancserv1_revenue_single
  • mp_ancserv2_percent_gen
  • mp_ancserv2_revenue_single
  • mp_ancserv3_percent_gen
  • mp_ancserv3_revenue_single
  • mp_ancserv4_percent_gen
  • mp_ancserv4_revenue_single
  • mp_enable_ancserv1_percent_gen
  • mp_enable_ancserv2_percent_gen
  • mp_enable_ancserv3_percent_gen
  • mp_enable_ancserv4_percent_gen
  • mp_enable_market_percent_gen
  • mp_energy_market_revenue_single
  • mp_market_percent_gen
  • net_billing_credits_ym
  • nm_dollars_applied_ym
  • om_batt_capacity_cost
  • om_batt_fixed_cost
  • om_batt_nameplate
  • om_batt_replacement_cost
  • om_batt_variable_cost
  • om_fuelcell_capacity_cost
  • om_fuelcell_fixed_cost
  • om_fuelcell_nameplate
  • om_fuelcell_replacement_cost
  • om_fuelcell_variable_cost
  • om_land_lease
  • om_land_lease_escal
  • true_up_credits_ym
  • year1_monthly_ec_charge_gross_with_system
  • year1_monthly_ec_charge_with_system
  • year1_monthly_electricity_to_grid
Removed:
  • om_capacity1
  • om_capacity1_nameplate
  • om_capacity2
  • om_capacity2_nameplate
  • om_fixed1
  • om_fixed2
  • om_production1
  • om_production2
  • om_replacement_cost1
  • om_replacement_cost2
  • roe_input
MhkTidal Added:
  • system_capacity
MhkWave Added:
  • day
  • energy_period
  • hour
  • minute
  • month
  • number_hours
  • number_records
  • significant_wave_height
  • wave_resource_data
  • wave_resource_model_choice
  • year
Pvsamv1 Added:
  • batt_Vcut
  • batt_dispatch_auto_btm_can_discharge_to_grid
  • batt_dispatch_charge_only_system_exceeds_load
  • batt_dispatch_discharge_only_load_exceeds_system
  • batt_dispatch_load_forecast_choice
  • batt_dispatch_pvs_ac_lb
  • batt_dispatch_pvs_ac_lb_enable
  • batt_dispatch_pvs_ac_ub
  • batt_dispatch_pvs_ac_ub_enable
  • batt_dispatch_pvs_curtail_as_control
  • batt_dispatch_pvs_curtail_if_violation
  • batt_dispatch_pvs_forecast_shift_periods
  • batt_dispatch_pvs_kf
  • batt_dispatch_pvs_ki
  • batt_dispatch_pvs_kp
  • batt_dispatch_pvs_max_ramp
  • batt_dispatch_pvs_nameplate_ac
  • batt_dispatch_pvs_short_forecast_enable
  • batt_dispatch_pvs_soc_rest
  • batt_dispatch_pvs_timestep_multiplier
  • batt_dispatch_wf_forecast_choice
  • batt_load_ac_forecast
  • batt_load_ac_forecast_escalation
  • batt_minimum_outage_SOC
  • crit_load_escalation
  • dispatch_manual_btm_discharge_to_grid
  • en_standalone_batt
  • enable_interconnection_limit
  • grid_curtailment
  • grid_interconnection_limit_kwac
  • grid_outage
  • mlm_bifacial_ground_clearance_height
  • mlm_bifacial_transmission_factor
  • mlm_bifaciality
  • mlm_is_bifacial
  • om_batt_replacement_cost
  • om_replacement_cost_escal
  • run_resiliency_calcs
  • subarray1_slope_azm
  • subarray1_slope_tilt
  • subarray2_slope_azm
  • subarray2_slope_tilt
  • subarray3_slope_azm
  • subarray3_slope_tilt
  • subarray4_slope_azm
  • subarray4_slope_tilt
  • ur_billing_demand_lookback_percentages
  • ur_billing_demand_lookback_period
  • ur_billing_demand_minimum
  • ur_dc_billing_demand_periods
  • ur_enable_billing_demand
  • ur_yearzero_usage_peaks
Removed:
  • batt_auto_gridcharge_max_daily
Saleleaseback Added:
  • batt_annual_charge_energy
  • batt_annual_charge_from_system
  • batt_annual_discharge_energy
  • batt_capacity_percent
  • batt_salvage_percentage
  • battery_total_cost_lcos
  • charge_w_sys_ec_ym
  • en_electricity_rates
  • en_standalone_batt
  • fuelcell_annual_energy_discharged
  • gen_purchases
  • grid_to_batt
  • land_area
  • monthly_batt_to_grid
  • monthly_grid_to_batt
  • monthly_grid_to_load
  • monthly_system_to_grid
  • net_billing_credits_ym
  • nm_dollars_applied_ym
  • om_batt_capacity_cost
  • om_batt_fixed_cost
  • om_batt_nameplate
  • om_batt_replacement_cost
  • om_batt_variable_cost
  • om_fuelcell_capacity_cost
  • om_fuelcell_fixed_cost
  • om_fuelcell_nameplate
  • om_fuelcell_replacement_cost
  • om_fuelcell_variable_cost
  • om_land_lease
  • om_land_lease_escal
  • true_up_credits_ym
  • utility_bill_w_sys
  • year1_monthly_ec_charge_gross_with_system
  • year1_monthly_ec_charge_with_system
  • year1_monthly_electricity_to_grid
Removed:
  • om_capacity1
  • om_capacity1_nameplate
  • om_capacity2
  • om_capacity2_nameplate
  • om_fixed1
  • om_fixed2
  • om_production1
  • om_production2
  • om_replacement_cost1
  • om_replacement_cost2
Singleowner Added:
  • batt_annual_charge_energy
  • batt_annual_charge_from_system
  • batt_annual_discharge_energy
  • batt_capacity_percent
  • batt_salvage_percentage
  • battery_total_cost_lcos
  • charge_w_sys_ec_ym
  • dscr_limit_debt_fraction
  • dscr_maximum_debt_fraction
  • en_standalone_batt
  • fuelcell_annual_energy_discharged
  • gen_purchases
  • grid_to_batt
  • land_area
  • monthly_batt_to_grid
  • monthly_grid_to_batt
  • monthly_grid_to_load
  • monthly_system_to_grid
  • net_billing_credits_ym
  • nm_dollars_applied_ym
  • om_batt_capacity_cost
  • om_batt_fixed_cost
  • om_batt_nameplate
  • om_batt_replacement_cost
  • om_batt_variable_cost
  • om_fuelcell_capacity_cost
  • om_fuelcell_fixed_cost
  • om_fuelcell_nameplate
  • om_fuelcell_replacement_cost
  • om_fuelcell_variable_cost
  • om_land_lease
  • om_land_lease_escal
  • true_up_credits_ym
  • year1_monthly_ec_charge_gross_with_system
  • year1_monthly_ec_charge_with_system
  • year1_monthly_electricity_to_grid
Removed:
  • om_capacity1
  • om_capacity1_nameplate
  • om_capacity2
  • om_capacity2_nameplate
  • om_fixed1
  • om_fixed2
  • om_production1
  • om_production2
  • om_replacement_cost1
  • om_replacement_cost2
  • roe_input
Solarpilot Added:
  • cav_rec_height
  • cav_rec_span
  • cav_rec_width
  • n_cav_rec_panels
  • receiver_type
TcsmoltenSalt Added:
  • cav_rec_height
  • cav_rec_passive_abs
  • cav_rec_passive_eps
  • cav_rec_span
  • cav_rec_width
  • csp_financial_model
  • en_electricity_rates
  • f_q_dot_des_allowable_su
  • f_q_dot_heater_min
  • heater_mult
  • hrs_startup_at_max_rate
  • is_parallel_htr
  • mp_energy_market_revenue
  • n_cav_rec_panels
  • piping_loss_coefficient
  • ppa_soln_mode
  • receiver_type
  • timestep_load_fractions
Removed:
  • P_high_limit
  • _sco2_P_high_limit
  • _sco2_P_ref
  • _sco2_T_amb_des
  • _sco2_T_approach
  • _sco2_T_htf_hot_des
  • _sco2_deltaT_PHX
  • _sco2_design_eff
  • _sco2_eta_c
  • _sco2_eta_t
  • _sco2_recup_eff_max
  • deltaT_PHX
  • eta_c
  • eta_t
  • fan_power_perc_net
  • is_sco2_preprocess
  • recup_eff_max
  • sco2_T_amb_des
  • sco2_T_approach
  • sco2_cycle_config
  • sco2ud_T_amb_high
  • sco2ud_T_amb_ind_od
  • sco2ud_T_amb_low
  • sco2ud_T_htf_cold_calc
  • sco2ud_T_htf_high
  • sco2ud_T_htf_ind_od
  • sco2ud_T_htf_low
  • sco2ud_m_dot_htf_high
  • sco2ud_m_dot_htf_ind_od
  • sco2ud_m_dot_htf_low
TroughPhysical Added:
  • csp_financial_model
  • disp_inventory_incentive
  • disp_wlim_maxspec
  • en_electricity_rates
  • mp_energy_market_revenue
  • non_solar_field_land_area_multiplier
  • ppa_soln_mode
  • specified_solar_multiple
  • specified_total_aperture
  • timestep_load_fractions
  • trough_loop_control
  • use_solar_mult_or_aperture_area
Removed:
  • SCADefocusArray
  • SCAInfoArray
  • is_hx
  • solar_mult
TroughPhysicalProcessHeat Added:
  • disp_inventory_incentive
  • disp_wlim_maxspec
  • non_solar_field_land_area_multiplier
  • specified_solar_multiple
  • timestep_load_fractions
  • trough_loop_control
Removed:
  • SCADefocusArray
  • SCAInfoArray
  • solar_mult
UiTesCalcs Added:
  • dt_hot
  • field_fluid
  • store_fl_props
  • store_fluid
Removed:
  • rec_htf
UiUdpcChecks Added:
  • T_htf_des_in
Utilityrate5 Added:
  • ur_billing_demand_lookback_percentages
  • ur_billing_demand_lookback_period
  • ur_billing_demand_minimum
  • ur_dc_billing_demand_periods
  • ur_enable_billing_demand
  • ur_yearzero_usage_peaks
WaveFileReader Added:
  • wave_resource_filename_ts
  • wave_resource_model_choice
Windpower Added:
  • max_turbine_override