Pvsamv1

Detailed photovoltaic system model with separate components for module and inverter

PySAM.Pvsamv1.default(config) → Pvsamv1

Load defaults for the configuration config. Available configurations are:

  • “FlatPlatePVAllEquityPartnershipFlip”
  • “FlatPlatePVCommercial”
  • “FlatPlatePVHostDeveloper”
  • “FlatPlatePVLCOECalculator”
  • “FlatPlatePVLeveragedPartnershipFlip”
  • “FlatPlatePVMerchantPlant”
  • “FlatPlatePVNone”
  • “FlatPlatePVResidential”
  • “FlatPlatePVSaleLeaseback”
  • “FlatPlatePVSingleOwner”
  • “FlatPlatePVThirdParty”
  • “PVBatteryAllEquityPartnershipFlip”
  • “PVBatteryCommercial”
  • “PVBatteryHostDeveloper”
  • “PVBatteryLeveragedPartnershipFlip”
  • “PVBatteryMerchantPlant”
  • “PVBatteryResidential”
  • “PVBatterySaleLeaseback”
  • “PVBatterySingleOwner”
  • “PVBatteryThirdParty”

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.Pvsamv1.from_existing(data, optional config) → Pvsamv1

Share data with an existing PySAM class. If optional config is a valid configuration name, load the module’s defaults for that configuration.

PySAM.Pvsamv1.new() → Pvsamv1
PySAM.Pvsamv1.wrap(ssc_data_t) → Pvsamv1

Load data from a PySSC object.

Warning

Do not call PySSC.data_free on the ssc_data_t provided to wrap()

Pvsamv1 is a wrapper for the SSC compute module cmod_pvsamv1.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.

  • 6par_aisc
  • 6par_bvoc
  • 6par_imp
  • 6par_isc
  • 6par_vmp
  • 6par_voc
  • cec_area
  • cec_i_mp_ref
  • cec_module_length
  • cec_module_width
  • cec_v_mp_ref
  • cec_v_oc_ref
  • inv_cec_cg_c0
  • inv_cec_cg_c1
  • inv_cec_cg_c2
  • inv_cec_cg_c3
  • inv_cec_cg_eff_cec
  • inv_cec_cg_paco
  • inv_cec_cg_pdco
  • inv_cec_cg_psco
  • inv_cec_cg_vdcmax
  • inv_cec_cg_vdco
  • inv_ds_paco
  • inv_ds_vdcmax
  • inv_num_mppt
  • inv_pd_eff
  • inv_pd_paco
  • inv_pd_pdco
  • inv_pd_vdcmax
  • inv_snl_c0
  • inv_snl_c1
  • inv_snl_c2
  • inv_snl_c3
  • inv_snl_eff_cec
  • inv_snl_paco
  • inv_snl_pdco
  • inv_snl_pso
  • inv_snl_vdcmax
  • inv_snl_vdco
  • inverter_count
  • inverter_model
  • module_model
  • mppt_hi_inverter
  • mppt_low_inverter
  • sd11par_Vmp0
  • sd11par_Voc0
  • snl_a
  • snl_a0
  • snl_a1
  • snl_a2
  • snl_a3
  • snl_a4
  • snl_aimp
  • snl_aisc
  • snl_area
  • snl_b
  • snl_b0
  • snl_b1
  • snl_b2
  • snl_b3
  • snl_b4
  • snl_b5
  • snl_bvmpo
  • snl_bvoco
  • snl_c0
  • snl_c1
  • snl_c2
  • snl_c3
  • snl_dtc
  • snl_fd
  • snl_impo
  • snl_isco
  • snl_mbvmp
  • snl_mbvoc
  • snl_module_structure
  • snl_n
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • snl_series_cells
  • snl_vmpo
  • snl_voco
  • spe_area
  • spe_eff0
  • spe_eff1
  • spe_eff2
  • spe_eff3
  • spe_eff4
  • spe_rad0
  • spe_rad1
  • spe_rad2
  • spe_rad3
  • spe_rad4
  • spe_reference
  • spe_vmp
  • spe_voc
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray2_modules_per_string
  • subarray2_nstrings
  • subarray3_enable
  • subarray3_modules_per_string
  • subarray3_nstrings
  • subarray4_enable
  • subarray4_modules_per_string
  • subarray4_nstrings
  • system_capacity

Functions

class PySAM.Pvsamv1.Pvsamv1

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.

Reopt_size_battery_post()

Given a PV system with Utilityrate5 parameters, get the optimal battery size. Wind and additional PV are disabled. Maps SAM compute module inputs to those of the ReOpt Lite API: Pvsamv1 model linked with Battery, Utilityrate5, with Cashloan optional.

For more information on which PySAM variables are used, see: https://github.com/NREL/ssc/blob/develop/ssc/cmod_pvsamv1_eqns.h

For an example, see the ‘Examples’ readthedocs page.

assign(dict) → None

Assign attributes from nested dictionary, except for Outputs

nested_dict = { 'Solar Resource': { var: val, ...}, ...}

execute(int verbosity) → None

Execute simulation with verbosity level 0 (default) or 1

export() → dict

Export attributes into nested dictionary

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 = { 'Solar Resource': { var: val, ...}, ...}

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.

SolarResource Group

class PySAM.Pvsamv1.Pvsamv1.SolarResource
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

SolarResource_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

SolarResource_vals = { var: val, ...}

albedo

User specified ground albedo [0..1]

Constraints: LENGTH=12

Required: True

Type:sequence
irrad_mode

Irradiance input translation mode

Options: 0=beam&diffuse,1=total&beam,2=total&diffuse,3=poa_reference,4=poa_pyranometer

Constraints: INTEGER,MIN=0,MAX=4

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
sky_model

Diffuse sky model

Options: 0=isotropic,1=hkdr,2=perez

Constraints: INTEGER,MIN=0,MAX=2

Required: False. Automatically set to 2 if not assigned explicitly or loaded from defaults.

Type:float
solar_resource_data

Weather data

Info: lat,lon,tz,elev,year,month,hour,minute,gh,dn,df,poa,tdry,twet,tdew,rhum,pres,snow,alb,aod,wspd,wdir

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:dict
solar_resource_file

Weather file in TMY2, TMY3, EPW, or SAM CSV

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:str
use_wf_albedo

Use albedo in weather file if provided [0/1]

Options: 0=user-specified,1=weatherfile

Constraints: BOOLEAN

Required: False. Automatically set to 1 if not assigned explicitly or loaded from defaults.

Type:float

Losses Group

class PySAM.Pvsamv1.Pvsamv1.Losses
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

Losses_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

Losses_vals = { var: val, ...}

acwiring_loss

AC wiring loss [%]

Constraints: MIN=0,MAX=100

Required: True

Type:float
dcoptimizer_loss

DC power optimizer loss [%]

Constraints: MIN=0,MAX=100

Required: True

Type:float
en_snow_model

Toggle snow loss estimation [0/1]

Constraints: BOOLEAN

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
subarray1_dcwiring_loss

Sub-array 1 DC wiring loss [%]

Constraints: MIN=0,MAX=100

Required: True

Type:float
subarray1_diodeconn_loss

Sub-array 1 DC diodes and connections loss [%]

Constraints: MIN=0,MAX=100

Required: True

Type:float
subarray1_mismatch_loss

Sub-array 1 DC mismatch loss [%]

Constraints: MIN=0,MAX=100

Required: True

Type:float
subarray1_nameplate_loss

Sub-array 1 DC nameplate loss [%]

Constraints: MIN=-5,MAX=100

Required: True

Type:float
subarray1_rear_irradiance_loss

Sub-array 1 rear irradiance loss [%]

Constraints: MIN=0,MAX=100

Required: True

Type:float
subarray1_soiling

Sub-array 1 Monthly soiling loss [%]

Constraints: LENGTH=12

Required: True

Type:sequence
subarray1_tracking_loss

Sub-array 1 DC tracking error loss [%]

Constraints: MIN=0,MAX=100

Required: True

Type:float
subarray2_dcwiring_loss

Sub-array 2 DC wiring loss [%]

Constraints: MIN=0,MAX=100

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:float
subarray2_diodeconn_loss

Sub-array 2 DC diodes and connections loss [%]

Constraints: MIN=0,MAX=100

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:float
subarray2_mismatch_loss

Sub-array 2 DC mismatch loss [%]

Constraints: MIN=0,MAX=100

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:float
subarray2_nameplate_loss

Sub-array 2 DC nameplate loss [%]

Constraints: MIN=-5,MAX=100

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:float
subarray2_rear_irradiance_loss

Sub-array 2 rear irradiance loss [%]

Constraints: MIN=0,MAX=100

Required: Required if subarray2_enable=1

Type:float
subarray2_soiling

Sub-array 2 Monthly soiling loss [%]

Constraints: LENGTH=12

Required: Required if subarray2_enable=1

Type:sequence
subarray2_tracking_loss

Sub-array 2 DC tracking error loss [%]

Constraints: MIN=0,MAX=100

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:float
subarray3_dcwiring_loss

Sub-array 3 DC wiring loss [%]

Constraints: MIN=0,MAX=100

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:float
subarray3_diodeconn_loss

Sub-array 3 DC diodes and connections loss [%]

Constraints: MIN=0,MAX=100

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:float
subarray3_mismatch_loss

Sub-array 3 DC mismatch loss [%]

Constraints: MIN=0,MAX=100

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:float
subarray3_nameplate_loss

Sub-array 3 DC nameplate loss [%]

Constraints: MIN=-5,MAX=100

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:float
subarray3_rear_irradiance_loss

Sub-array 3 rear irradiance loss [%]

Constraints: MIN=0,MAX=100

Required: Required if subarray3_enable=1

Type:float
subarray3_soiling

Sub-array 3 Monthly soiling loss [%]

Constraints: LENGTH=12

Required: Required if subarray3_enable=1

Type:sequence
subarray3_tracking_loss

Sub-array 3 DC tracking error loss [%]

Constraints: MIN=0,MAX=100

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:float
subarray4_dcwiring_loss

Sub-array 4 DC wiring loss [%]

Constraints: MIN=0,MAX=100

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:float
subarray4_diodeconn_loss

Sub-array 4 DC diodes and connections loss [%]

Info: ?

Constraints: MIN=0,MAX=100

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:float
subarray4_mismatch_loss

Sub-array 4 DC mismatch loss [%]

Constraints: MIN=0,MAX=100

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:float
subarray4_nameplate_loss

Sub-array 4 DC nameplate loss [%]

Constraints: MIN=-5,MAX=100

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:float
subarray4_rear_irradiance_loss

Sub-array 4 rear irradiance loss [%]

Constraints: MIN=0,MAX=100

Required: Required if subarray4_enable=1

Type:float
subarray4_soiling

Sub-array 4 Monthly soiling loss [%]

Constraints: LENGTH=12

Required: Required if subarray4_enable=1

Type:sequence
subarray4_tracking_loss

Sub-array 4 DC tracking error loss [%]

Constraints: MIN=0,MAX=100

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:float
transformer_load_loss

Power transformer load loss [%]

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
transformer_no_load_loss

Power transformer no load loss [%]

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
transmission_loss

Transmission loss [%]

Constraints: MIN=0,MAX=100

Required: True

Type:float

Lifetime Group

class PySAM.Pvsamv1.Pvsamv1.Lifetime
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

Lifetime_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

Lifetime_vals = { var: val, ...}

ac_lifetime_losses

Lifetime daily AC losses [%]

Required: Required if en_ac_lifetime_losses=1

Type:sequence
analysis_period

Lifetime analysis period [years]

Required: Required if system_use_lifetime_output=1

Type:float
dc_degradation

Annual DC degradation [%/year]

Required: Required if system_use_lifetime_output=1

Type:sequence
dc_lifetime_losses

Lifetime daily DC losses [%]

Required: Required if en_dc_lifetime_losses=1

Type:sequence
en_ac_lifetime_losses

Enable lifetime daily AC losses [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
en_dc_lifetime_losses

Enable lifetime daily DC losses [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
inflation_rate

Inflation rate [%]

Constraints: MIN=-99

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
save_full_lifetime_variables

Save and display vars for full lifetime [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: False. Automatically set to 1 if not assigned explicitly or loaded from defaults.

Type:float
system_use_lifetime_output

PV lifetime simulation [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float

SystemDesign Group

class PySAM.Pvsamv1.Pvsamv1.SystemDesign
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

SystemDesign_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

SystemDesign_vals = { var: val, ...}

enable_mismatch_vmax_calc

Enable mismatched subarray Vmax calculation

Constraints: BOOLEAN

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
inverter_count

Number of inverters

Constraints: INTEGER,POSITIVE

Required: True

The value of inverter_count depends on the following variables:

  • 6par_imp
  • 6par_vmp
  • 6par_voc
  • cec_i_mp_ref
  • cec_v_mp_ref
  • cec_v_oc_ref
  • inv_cec_cg_paco
  • inv_cec_cg_vdcmax
  • inv_ds_paco
  • inv_ds_vdcmax
  • inv_pd_paco
  • inv_pd_vdcmax
  • inv_snl_paco
  • inv_snl_vdcmax
  • inverter_model
  • module_model
  • sd11par_Vmp0
  • sd11par_Voc0
  • snl_a
  • snl_a0
  • snl_a1
  • snl_a2
  • snl_a3
  • snl_a4
  • snl_aimp
  • snl_aisc
  • snl_area
  • snl_b
  • snl_b0
  • snl_b1
  • snl_b2
  • snl_b3
  • snl_b4
  • snl_b5
  • snl_bvmpo
  • snl_bvoco
  • snl_c0
  • snl_c1
  • snl_c2
  • snl_c3
  • snl_dtc
  • snl_fd
  • snl_impo
  • snl_isco
  • snl_mbvmp
  • snl_mbvoc
  • snl_module_structure
  • snl_n
  • snl_series_cells
  • snl_vmpo
  • snl_voco
  • spe_area
  • spe_eff0
  • spe_eff1
  • spe_eff2
  • spe_eff3
  • spe_eff4
  • spe_rad0
  • spe_rad1
  • spe_rad2
  • spe_rad3
  • spe_rad4
  • spe_reference
  • spe_vmp
  • spe_voc
Type:float
subarray1_azimuth

Sub-array 1 Azimuth [deg]

Options: 0=N,90=E,180=S,270=W

Constraints: MIN=0,MAX=359.9

Type:float
subarray1_backtrack

Sub-array 1 Backtracking enabled

Options: 0=no backtracking,1=backtrack

Constraints: BOOLEAN

Required: Required if subarray1_track_mode=1

Type:float
subarray1_gcr

Sub-array 1 Ground coverage ratio [0..1]

Constraints: MIN=0.01,MAX=0.99

Required: False. Automatically set to 0.3 if not assigned explicitly or loaded from defaults.

Type:float
subarray1_modules_per_string

Sub-array 1 Modules per string

Constraints: INTEGER,POSITIVE

Required: True

The value of the following variables depends on subarray1_modules_per_string:

  • system_capacity

The value of subarray1_modules_per_string depends on the following variables:

  • 6par_imp
  • 6par_vmp
  • 6par_voc
  • cec_i_mp_ref
  • cec_v_mp_ref
  • cec_v_oc_ref
  • inv_cec_cg_paco
  • inv_cec_cg_vdcmax
  • inv_ds_paco
  • inv_ds_vdcmax
  • inv_pd_paco
  • inv_pd_vdcmax
  • inv_snl_paco
  • inv_snl_vdcmax
  • inverter_model
  • module_model
  • sd11par_Vmp0
  • sd11par_Voc0
  • snl_a
  • snl_a0
  • snl_a1
  • snl_a2
  • snl_a3
  • snl_a4
  • snl_aimp
  • snl_aisc
  • snl_area
  • snl_b
  • snl_b0
  • snl_b1
  • snl_b2
  • snl_b3
  • snl_b4
  • snl_b5
  • snl_bvmpo
  • snl_bvoco
  • snl_c0
  • snl_c1
  • snl_c2
  • snl_c3
  • snl_dtc
  • snl_fd
  • snl_impo
  • snl_isco
  • snl_mbvmp
  • snl_mbvoc
  • snl_module_structure
  • snl_n
  • snl_series_cells
  • snl_vmpo
  • snl_voco
  • spe_area
  • spe_eff0
  • spe_eff1
  • spe_eff2
  • spe_eff3
  • spe_eff4
  • spe_rad0
  • spe_rad1
  • spe_rad2
  • spe_rad3
  • spe_rad4
  • spe_reference
  • spe_vmp
  • spe_voc
Type:float
subarray1_monthly_tilt

Sub-array 1 monthly tilt input [deg]

Constraints: LENGTH=12

Required: Required if subarray1_track_mode=4

Type:sequence
subarray1_mppt_input

Sub-array 1 Inverter MPPT input number

Constraints: INTEGER,POSITIVE

Required: False. Automatically set to 1 if not assigned explicitly or loaded from defaults.

Type:float
subarray1_nstrings

Sub-array 1 Number of parallel strings

Constraints: INTEGER

The value of the following variables depends on subarray1_nstrings:

  • system_capacity

The value of subarray1_nstrings depends on the following variables:

  • 6par_imp
  • 6par_vmp
  • 6par_voc
  • cec_i_mp_ref
  • cec_v_mp_ref
  • cec_v_oc_ref
  • inv_cec_cg_paco
  • inv_cec_cg_vdcmax
  • inv_ds_paco
  • inv_ds_vdcmax
  • inv_pd_paco
  • inv_pd_vdcmax
  • inv_snl_paco
  • inv_snl_vdcmax
  • inverter_model
  • module_model
  • sd11par_Vmp0
  • sd11par_Voc0
  • snl_a
  • snl_a0
  • snl_a1
  • snl_a2
  • snl_a3
  • snl_a4
  • snl_aimp
  • snl_aisc
  • snl_area
  • snl_b
  • snl_b0
  • snl_b1
  • snl_b2
  • snl_b3
  • snl_b4
  • snl_b5
  • snl_bvmpo
  • snl_bvoco
  • snl_c0
  • snl_c1
  • snl_c2
  • snl_c3
  • snl_dtc
  • snl_fd
  • snl_impo
  • snl_isco
  • snl_mbvmp
  • snl_mbvoc
  • snl_module_structure
  • snl_n
  • snl_series_cells
  • snl_vmpo
  • snl_voco
  • spe_area
  • spe_eff0
  • spe_eff1
  • spe_eff2
  • spe_eff3
  • spe_eff4
  • spe_rad0
  • spe_rad1
  • spe_rad2
  • spe_rad3
  • spe_rad4
  • spe_reference
  • spe_vmp
  • spe_voc
Type:float
subarray1_rotlim

Sub-array 1 Tracker rotation limit [deg]

Constraints: MIN=0,MAX=85

Required: False. Automatically set to 45 if not assigned explicitly or loaded from defaults.

Type:float
subarray1_slope_azm

Sub-array 1 terrain azimuth [deg]

Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.

Type:float
subarray1_slope_tilt

Sub-array 1 terrain tilt [deg]

Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.

Type:float
subarray1_tilt

Sub-array 1 Tilt [deg]

Options: 0=horizontal,90=vertical

Constraints: MIN=0,MAX=90

Type:float
subarray1_tilt_eq_lat

Sub-array 1 Tilt=latitude override [0/1]

Options: 0=false,1=override

Constraints: BOOLEAN

Type:float
subarray1_track_mode

Sub-array 1 Tracking mode

Options: 0=fixed,1=1axis,2=2axis,3=azi,4=monthly

Constraints: INTEGER,MIN=0,MAX=4

Required: True

Type:float
subarray2_azimuth

Sub-array 2 Azimuth [deg]

Options: 0=N,90=E,180=S,270=W

Constraints: MIN=0,MAX=359.9

Type:float
subarray2_backtrack

Sub-array 2 Backtracking enabled

Options: 0=no backtracking,1=backtrack

Constraints: BOOLEAN

Type:float
subarray2_enable

Sub-array 2 Enable [0/1]

Options: 0=disabled,1=enabled

Constraints: BOOLEAN

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

The value of the following variables depends on subarray2_enable:

  • system_capacity

The value of subarray2_enable depends on the following variables:

  • 6par_imp
  • 6par_vmp
  • 6par_voc
  • cec_i_mp_ref
  • cec_v_mp_ref
  • cec_v_oc_ref
  • inv_cec_cg_paco
  • inv_cec_cg_vdcmax
  • inv_ds_paco
  • inv_ds_vdcmax
  • inv_pd_paco
  • inv_pd_vdcmax
  • inv_snl_paco
  • inv_snl_vdcmax
  • inverter_model
  • module_model
  • sd11par_Vmp0
  • sd11par_Voc0
  • snl_a
  • snl_a0
  • snl_a1
  • snl_a2
  • snl_a3
  • snl_a4
  • snl_aimp
  • snl_aisc
  • snl_area
  • snl_b
  • snl_b0
  • snl_b1
  • snl_b2
  • snl_b3
  • snl_b4
  • snl_b5
  • snl_bvmpo
  • snl_bvoco
  • snl_c0
  • snl_c1
  • snl_c2
  • snl_c3
  • snl_dtc
  • snl_fd
  • snl_impo
  • snl_isco
  • snl_mbvmp
  • snl_mbvoc
  • snl_module_structure
  • snl_n
  • snl_series_cells
  • snl_vmpo
  • snl_voco
  • spe_area
  • spe_eff0
  • spe_eff1
  • spe_eff2
  • spe_eff3
  • spe_eff4
  • spe_rad0
  • spe_rad1
  • spe_rad2
  • spe_rad3
  • spe_rad4
  • spe_reference
  • spe_vmp
  • spe_voc
Type:float
subarray2_gcr

Sub-array 2 Ground coverage ratio [0..1]

Constraints: MIN=0.01,MAX=0.99

Required: False. Automatically set to 0.3 if not assigned explicitly or loaded from defaults.

Type:float
subarray2_modules_per_string

Sub-array 2 Modules per string

Constraints: INTEGER,MIN=1

Required: Required if subarray2_enable=1

The value of the following variables depends on subarray2_modules_per_string:

  • system_capacity
Type:float
subarray2_monthly_tilt

Sub-array 2 Monthly tilt input [deg]

Constraints: LENGTH=12

Type:sequence
subarray2_mppt_input

Sub-array 2 Inverter MPPT input number

Constraints: INTEGER,POSITIVE

Required: False. Automatically set to 1 if not assigned explicitly or loaded from defaults.

Type:float
subarray2_nstrings

Sub-array 2 Number of parallel strings

Constraints: INTEGER,MIN=1

Required: Required if subarray2_enable=1

The value of the following variables depends on subarray2_nstrings:

  • system_capacity
Type:float
subarray2_rotlim

Sub-array 2 Tracker rotation limit [deg]

Constraints: MIN=0,MAX=85

Required: False. Automatically set to 45 if not assigned explicitly or loaded from defaults.

Type:float
subarray2_slope_azm

Sub-array 2 terrain azimuth [deg]

Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.

Type:float
subarray2_slope_tilt

Sub-array 2 terrain tilt [deg]

Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.

Type:float
subarray2_tilt

Sub-array 2 Tilt [deg]

Options: 0=horizontal,90=vertical

Constraints: MIN=0,MAX=90

Type:float
subarray2_tilt_eq_lat

Sub-array 2 Tilt=latitude override [0/1]

Options: 0=false,1=override

Constraints: BOOLEAN

Type:float
subarray2_track_mode

Sub-array 2 Tracking mode

Options: 0=fixed,1=1axis,2=2axis,3=azi,4=monthly

Constraints: INTEGER,MIN=0,MAX=4

Required: Required if subarray2_enable=1

Type:float
subarray3_azimuth

Sub-array 3 Azimuth [deg]

Options: 0=N,90=E,180=S,270=W

Constraints: MIN=0,MAX=359.9

Type:float
subarray3_backtrack

Sub-array 3 Backtracking enabled

Options: 0=no backtracking,1=backtrack

Constraints: BOOLEAN

Type:float
subarray3_enable

Sub-array 3 Enable [0/1]

Options: 0=disabled,1=enabled

Constraints: BOOLEAN

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

The value of the following variables depends on subarray3_enable:

  • system_capacity

The value of subarray3_enable depends on the following variables:

  • 6par_imp
  • 6par_vmp
  • 6par_voc
  • cec_i_mp_ref
  • cec_v_mp_ref
  • cec_v_oc_ref
  • inv_cec_cg_paco
  • inv_cec_cg_vdcmax
  • inv_ds_paco
  • inv_ds_vdcmax
  • inv_pd_paco
  • inv_pd_vdcmax
  • inv_snl_paco
  • inv_snl_vdcmax
  • inverter_model
  • module_model
  • sd11par_Vmp0
  • sd11par_Voc0
  • snl_a
  • snl_a0
  • snl_a1
  • snl_a2
  • snl_a3
  • snl_a4
  • snl_aimp
  • snl_aisc
  • snl_area
  • snl_b
  • snl_b0
  • snl_b1
  • snl_b2
  • snl_b3
  • snl_b4
  • snl_b5
  • snl_bvmpo
  • snl_bvoco
  • snl_c0
  • snl_c1
  • snl_c2
  • snl_c3
  • snl_dtc
  • snl_fd
  • snl_impo
  • snl_isco
  • snl_mbvmp
  • snl_mbvoc
  • snl_module_structure
  • snl_n
  • snl_series_cells
  • snl_vmpo
  • snl_voco
  • spe_area
  • spe_eff0
  • spe_eff1
  • spe_eff2
  • spe_eff3
  • spe_eff4
  • spe_rad0
  • spe_rad1
  • spe_rad2
  • spe_rad3
  • spe_rad4
  • spe_reference
  • spe_vmp
  • spe_voc
Type:float
subarray3_gcr

Sub-array 3 Ground coverage ratio [0..1]

Constraints: MIN=0.01,MAX=0.99

Required: False. Automatically set to 0.3 if not assigned explicitly or loaded from defaults.

Type:float
subarray3_modules_per_string

Sub-array 3 Modules per string

Constraints: INTEGER,MIN=1

Required: Required if subarray3_enable=1

The value of the following variables depends on subarray3_modules_per_string:

  • system_capacity
Type:float
subarray3_monthly_tilt

Sub-array 3 Monthly tilt input [deg]

Constraints: LENGTH=12

Type:sequence
subarray3_mppt_input

Sub-array 3 Inverter MPPT input number

Constraints: INTEGER,POSITIVE

Required: False. Automatically set to 1 if not assigned explicitly or loaded from defaults.

Type:float
subarray3_nstrings

Sub-array 3 Number of parallel strings

Constraints: INTEGER,MIN=1

Required: Required if subarray3_enable=1

The value of the following variables depends on subarray3_nstrings:

  • system_capacity
Type:float
subarray3_rotlim

Sub-array 3 Tracker rotation limit [deg]

Constraints: MIN=0,MAX=85

Required: False. Automatically set to 45 if not assigned explicitly or loaded from defaults.

Type:float
subarray3_slope_azm

Sub-array 3 terrain azimuth [deg]

Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.

Type:float
subarray3_slope_tilt

Sub-array 3 terrain tilt [deg]

Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.

Type:float
subarray3_tilt

Sub-array 3 Tilt [deg]

Options: 0=horizontal,90=vertical

Constraints: MIN=0,MAX=90

Type:float
subarray3_tilt_eq_lat

Sub-array 3 Tilt=latitude override [0/1]

Options: 0=false,1=override

Constraints: BOOLEAN

Type:float
subarray3_track_mode

Sub-array 3 Tracking mode

Options: 0=fixed,1=1axis,2=2axis,3=azi,4=monthly

Constraints: INTEGER,MIN=0,MAX=4

Required: Required if subarray3_enable=1

Type:float
subarray4_azimuth

Sub-array 4 Azimuth [deg]

Options: 0=N,90=E,180=S,270=W

Constraints: MIN=0,MAX=359.9

Type:float
subarray4_backtrack

Sub-array 4 Backtracking enabled

Options: 0=no backtracking,1=backtrack

Constraints: BOOLEAN

Type:float
subarray4_enable

Sub-array 4 Enable [0/1]

Options: 0=disabled,1=enabled

Constraints: BOOLEAN

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

The value of the following variables depends on subarray4_enable:

  • system_capacity

The value of subarray4_enable depends on the following variables:

  • 6par_imp
  • 6par_vmp
  • 6par_voc
  • cec_i_mp_ref
  • cec_v_mp_ref
  • cec_v_oc_ref
  • inv_cec_cg_paco
  • inv_cec_cg_vdcmax
  • inv_ds_paco
  • inv_ds_vdcmax
  • inv_pd_paco
  • inv_pd_vdcmax
  • inv_snl_paco
  • inv_snl_vdcmax
  • inverter_model
  • module_model
  • sd11par_Vmp0
  • sd11par_Voc0
  • snl_a
  • snl_a0
  • snl_a1
  • snl_a2
  • snl_a3
  • snl_a4
  • snl_aimp
  • snl_aisc
  • snl_area
  • snl_b
  • snl_b0
  • snl_b1
  • snl_b2
  • snl_b3
  • snl_b4
  • snl_b5
  • snl_bvmpo
  • snl_bvoco
  • snl_c0
  • snl_c1
  • snl_c2
  • snl_c3
  • snl_dtc
  • snl_fd
  • snl_impo
  • snl_isco
  • snl_mbvmp
  • snl_mbvoc
  • snl_module_structure
  • snl_n
  • snl_series_cells
  • snl_vmpo
  • snl_voco
  • spe_area
  • spe_eff0
  • spe_eff1
  • spe_eff2
  • spe_eff3
  • spe_eff4
  • spe_rad0
  • spe_rad1
  • spe_rad2
  • spe_rad3
  • spe_rad4
  • spe_reference
  • spe_vmp
  • spe_voc
Type:float
subarray4_gcr

Sub-array 4 Ground coverage ratio [0..1]

Constraints: MIN=0.01,MAX=0.99

Required: False. Automatically set to 0.3 if not assigned explicitly or loaded from defaults.

Type:float
subarray4_modules_per_string

Sub-array 4 Modules per string

Constraints: INTEGER,MIN=1

Required: Required if subarray4_enable=1

The value of the following variables depends on subarray4_modules_per_string:

  • system_capacity
Type:float
subarray4_monthly_tilt

Sub-array 4 Monthly tilt input [deg]

Constraints: LENGTH=12

Type:sequence
subarray4_mppt_input

Sub-array 4 Inverter MPPT input number

Constraints: INTEGER,POSITIVE

Required: False. Automatically set to 1 if not assigned explicitly or loaded from defaults.

Type:float
subarray4_nstrings

Sub-array 4 Number of parallel strings

Constraints: INTEGER,MIN=1

Required: Required if subarray4_enable=1

The value of the following variables depends on subarray4_nstrings:

  • system_capacity
Type:float
subarray4_rotlim

Sub-array 4 Tracker rotation limit [deg]

Constraints: MIN=0,MAX=85

Required: False. Automatically set to 45 if not assigned explicitly or loaded from defaults.

Type:float
subarray4_slope_azm

Sub-array 4 terrain azimuth [deg]

Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.

Type:float
subarray4_slope_tilt

Sub-array 4 terrain tilt [deg]

Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.

Type:float
subarray4_tilt

Sub-array 4 Tilt [deg]

Options: 0=horizontal,90=vertical

Constraints: MIN=0,MAX=90

Type:float
subarray4_tilt_eq_lat

Sub-array 4 Tilt=latitude override [0/1]

Options: 0=false,1=override

Constraints: BOOLEAN

Type:float
subarray4_track_mode

Sub-array 4 Tracking mode

Options: 0=fixed,1=1axis,2=2axis,3=azi,4=monthly

Constraints: INTEGER,MIN=0,MAX=4

Required: Required if subarray4_enable=1

Type:float
system_capacity

DC Nameplate capacity [kWdc]

Required: True

The value of system_capacity depends on the following variables:

  • 6par_imp
  • 6par_vmp
  • 6par_voc
  • cec_i_mp_ref
  • cec_v_mp_ref
  • cec_v_oc_ref
  • inv_cec_cg_paco
  • inv_cec_cg_vdcmax
  • inv_ds_paco
  • inv_ds_vdcmax
  • inv_pd_paco
  • inv_pd_vdcmax
  • inv_snl_paco
  • inv_snl_vdcmax
  • inverter_model
  • module_model
  • sd11par_Vmp0
  • sd11par_Voc0
  • snl_a
  • snl_a0
  • snl_a1
  • snl_a2
  • snl_a3
  • snl_a4
  • snl_aimp
  • snl_aisc
  • snl_area
  • snl_b
  • snl_b0
  • snl_b1
  • snl_b2
  • snl_b3
  • snl_b4
  • snl_b5
  • snl_bvmpo
  • snl_bvoco
  • snl_c0
  • snl_c1
  • snl_c2
  • snl_c3
  • snl_dtc
  • snl_fd
  • snl_impo
  • snl_isco
  • snl_mbvmp
  • snl_mbvoc
  • snl_module_structure
  • snl_n
  • snl_series_cells
  • snl_vmpo
  • snl_voco
  • spe_area
  • spe_eff0
  • spe_eff1
  • spe_eff2
  • spe_eff3
  • spe_eff4
  • spe_rad0
  • spe_rad1
  • spe_rad2
  • spe_rad3
  • spe_rad4
  • spe_reference
  • spe_vmp
  • spe_voc
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray2_modules_per_string
  • subarray2_nstrings
  • subarray3_enable
  • subarray3_modules_per_string
  • subarray3_nstrings
  • subarray4_enable
  • subarray4_modules_per_string
  • subarray4_nstrings
Type:float

Shading Group

class PySAM.Pvsamv1.Pvsamv1.Shading
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

Shading_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

Shading_vals = { var: val, ...}

subarray1_shade_mode

Sub-array 1 shading mode (fixed tilt or 1x tracking) [0/1/2]

Options: 0=none,1=standard(non-linear),2=thin film(linear)

Constraints: INTEGER,MIN=0,MAX=2

Required: True

Type:float
subarray1_shading_azal

Sub-array 1 Azimuth x altitude beam shading losses [%]

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[sequence]
subarray1_shading_diff

Sub-array 1 Diffuse shading loss [%]

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:float
subarray1_shading_mxh

Sub-array 1 Month x Hour beam shading losses [%]

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[sequence]
subarray1_shading_string_option

Sub-array 1 shading string option

Options: 0=shadingdb,1=average,2=maximum,3=minimum

Constraints: INTEGER,MIN=-1,MAX=4

Required: False. Automatically set to -1 if not assigned explicitly or loaded from defaults.

Type:float
subarray1_shading_timestep

Sub-array 1 timestep beam shading losses [%]

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[sequence]
subarray2_shade_mode

Sub-array 2 Shading mode (fixed tilt or 1x tracking) [0/1/2]

Options: 0=none,1=standard(non-linear),2=thin film(linear)

Constraints: INTEGER,MIN=0,MAX=2

Required: Required if subarray2_enable=1

Type:float
subarray2_shading_azal

Sub-array 2 Azimuth x altitude beam shading losses [%]

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[sequence]
subarray2_shading_diff

Sub-array 2 Diffuse shading loss [%]

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:float
subarray2_shading_mxh

Sub-array 2 Month x Hour beam shading losses [%]

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[sequence]
subarray2_shading_string_option

Sub-array 2 Shading string option

Options: 0=shadingdb,1=average,2=maximum,3=minimum

Constraints: INTEGER,MIN=-1,MAX=4

Required: False. Automatically set to -1 if not assigned explicitly or loaded from defaults.

Type:float
subarray2_shading_timestep

Sub-array 2 Timestep beam shading losses [%]

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[sequence]
subarray3_shade_mode

Sub-array 3 Shading mode (fixed tilt or 1x tracking) [0/1/2]

Options: 0=none,1=standard(non-linear),2=thin film(linear)

Constraints: INTEGER,MIN=0,MAX=2

Required: Required if subarray3_enable=1

Type:float
subarray3_shading_azal

Sub-array 3 Azimuth x altitude beam shading losses [%]

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[sequence]
subarray3_shading_diff

Sub-array 3 Diffuse shading loss [%]

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:float
subarray3_shading_mxh

Sub-array 3 Month x Hour beam shading losses [%]

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[sequence]
subarray3_shading_string_option

Sub-array 3 Shading string option

Options: 0=shadingdb,1=average,2=maximum,3=minimum

Constraints: INTEGER,MIN=-1,MAX=4

Required: False. Automatically set to -1 if not assigned explicitly or loaded from defaults.

Type:float
subarray3_shading_timestep

Sub-array 3 Timestep beam shading losses [%]

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[sequence]
subarray4_shade_mode

Sub-array 4 shading mode (fixed tilt or 1x tracking) [0/1/2]

Options: 0=none,1=standard(non-linear),2=thin film(linear)

Constraints: INTEGER,MIN=0,MAX=2

Required: Required if subarray4_enable=1

Type:float
subarray4_shading_azal

Sub-array 4 Azimuth x altitude beam shading losses [%]

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[sequence]
subarray4_shading_diff

Sub-array 4 Diffuse shading loss [%]

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:float
subarray4_shading_mxh

Sub-array 4 Month x Hour beam shading losses [%]

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[sequence]
subarray4_shading_string_option

Sub-array 4 Shading string option

Options: 0=shadingdb,1=average,2=maximum,3=minimum

Constraints: INTEGER,MIN=-1,MAX=4

Required: False. Automatically set to -1 if not assigned explicitly or loaded from defaults.

Type:float
subarray4_shading_timestep

Sub-array 4 Timestep beam shading losses [%]

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[sequence]

Layout Group

class PySAM.Pvsamv1.Pvsamv1.Layout
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

Layout_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

Layout_vals = { var: val, ...}

module_aspect_ratio

Module aspect ratio

Constraints: POSITIVE

Required: False. Automatically set to 1.7 if not assigned explicitly or loaded from defaults.

Type:float
subarray1_mod_orient

Sub-array 1 Module orientation [0/1]

Options: 0=portrait,1=landscape

Constraints: INTEGER,MIN=0,MAX=1

Required: True

Type:float
subarray1_nmodx

Sub-array 1 Number of modules along bottom of row

Constraints: INTEGER,POSITIVE

Required: True

Type:float
subarray1_nmody

Sub-array 1 Number of modules along side of row

Constraints: INTEGER,POSITIVE

Required: True

Type:float
subarray2_mod_orient

Sub-array 2 Module orientation [0/1]

Options: 0=portrait,1=landscape

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if subarray2_enable=1

Type:float
subarray2_nmodx

Sub-array 2 Number of modules along bottom of row

Constraints: INTEGER,POSITIVE

Required: Required if subarray2_enable=1

Type:float
subarray2_nmody

Sub-array 2 Number of modules along side of row

Constraints: INTEGER,POSITIVE

Required: Required if subarray2_enable=1

Type:float
subarray3_mod_orient

Sub-array 3 Module orientation [0/1]

Options: 0=portrait,1=landscape

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if subarray3_enable=1

Type:float
subarray3_nmodx

Sub-array 3 Number of modules along bottom of row

Constraints: INTEGER,POSITIVE

Required: Required if subarray3_enable=1

Type:float
subarray3_nmody

Sub-array 3 Number of modules along side of row

Constraints: INTEGER,POSITIVE

Required: Required if subarray3_enable=1

Type:float
subarray4_mod_orient

Sub-array 4 Module orientation [0/1]

Options: 0=portrait,1=landscape

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if subarray4_enable=1

Type:float
subarray4_nmodx

Sub-array 4 Number of modules along bottom of row

Constraints: INTEGER,POSITIVE

Required: Required if subarray4_enable=1

Type:float
subarray4_nmody

Sub-array 4 Number of modules along side of row

Constraints: INTEGER,POSITIVE

Required: Required if subarray4_enable=1

Type:float

Module Group

class PySAM.Pvsamv1.Pvsamv1.Module
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

Module_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

Module_vals = { var: val, ...}

module_model

Photovoltaic module model specifier

Options: 0=spe,1=cec,2=6par_user,3=snl,4=sd11-iec61853,5=PVYield

Constraints: INTEGER,MIN=0,MAX=5

Required: True

The value of the following variables depends on module_model:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float

SimpleEfficiencyModuleModel Group

class PySAM.Pvsamv1.Pvsamv1.SimpleEfficiencyModuleModel
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

SimpleEfficiencyModuleModel_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

SimpleEfficiencyModuleModel_vals = { var: val, ...}

spe_a

Cell temp parameter a

Required: Required if module_model=0

Type:float
spe_area

Module area [m2]

Required: Required if module_model=0

The value of the following variables depends on spe_area:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
spe_b

Cell temp parameter b

Required: Required if module_model=0

Type:float
spe_bifacial_ground_clearance_height

Module ground clearance height [m]

Required: Required if module_model=0

Type:float
spe_bifacial_transmission_factor

Bifacial transmission factor [0-1]

Required: Required if module_model=0

Type:float
spe_bifaciality

Bifaciality factor [%]

Required: Required if module_model=0

Type:float
spe_dT

Cell temp parameter dT

Required: Required if module_model=0

Type:float
spe_eff0

Efficiency at irradiance level 0 [%]

Required: Required if module_model=0

The value of the following variables depends on spe_eff0:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
spe_eff1

Efficiency at irradiance level 1 [%]

Required: Required if module_model=0

The value of the following variables depends on spe_eff1:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
spe_eff2

Efficiency at irradiance level 2 [%]

Required: Required if module_model=0

The value of the following variables depends on spe_eff2:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
spe_eff3

Efficiency at irradiance level 3 [%]

Required: Required if module_model=0

The value of the following variables depends on spe_eff3:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
spe_eff4

Efficiency at irradiance level 4 [%]

Required: Required if module_model=0

The value of the following variables depends on spe_eff4:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
spe_fd

Diffuse fraction [0..1]

Constraints: MIN=0,MAX=1

Required: Required if module_model=0

Type:float
spe_is_bifacial

Modules are bifacial [0/1]

Required: Required if module_model=0

Type:float
spe_module_structure

Mounting and module structure

Options: 0=glass/cell/polymer sheet - open rack,1=glass/cell/glass - open rack,2=polymer/thin film/steel - open rack,3=Insulated back, building-integrated PV,4=close roof mount,5=user-defined

Constraints: INTEGER,MIN=0,MAX=5

Required: Required if module_model=0

Type:float
spe_rad0

Irradiance level 0 [W/m2]

Required: Required if module_model=0

The value of the following variables depends on spe_rad0:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
spe_rad1

Irradiance level 1 [W/m2]

Required: Required if module_model=0

The value of the following variables depends on spe_rad1:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
spe_rad2

Irradiance level 2 [W/m2]

Required: Required if module_model=0

The value of the following variables depends on spe_rad2:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
spe_rad3

Irradiance level 3 [W/m2]

Required: Required if module_model=0

The value of the following variables depends on spe_rad3:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
spe_rad4

Irradiance level 4 [W/m2]

Required: Required if module_model=0

The value of the following variables depends on spe_rad4:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
spe_reference

Reference irradiance level

Constraints: INTEGER,MIN=0,MAX=4

Required: Required if module_model=0

The value of the following variables depends on spe_reference:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
spe_temp_coeff

Temperature coefficient [%/C]

Required: Required if module_model=0

Type:float
spe_vmp

Nominal max power voltage [V]

Constraints: POSITIVE

Required: Required if module_model=0

The value of the following variables depends on spe_vmp:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
spe_voc

Nominal open circuit voltage [V]

Constraints: POSITIVE

Required: Required if module_model=0

The value of the following variables depends on spe_voc:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float

CECPerformanceModelWithModuleDatabase Group

class PySAM.Pvsamv1.Pvsamv1.CECPerformanceModelWithModuleDatabase
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

CECPerformanceModelWithModuleDatabase_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

CECPerformanceModelWithModuleDatabase_vals = { var: val, ...}

cec_a_ref

Nonideality factor a

Required: Required if module_model=1

Type:float
cec_adjust

Temperature coefficient adjustment [%]

Required: Required if module_model=1

Type:float
cec_alpha_sc

Short circuit current temperature coefficient [A/C]

Required: Required if module_model=1

Type:float
cec_area

Module area [m2]

Required: Required if module_model=1

The value of the following variables depends on cec_area:

  • cec_module_length
Type:float
cec_array_cols

Columns of modules in array

Required: Required if module_model=1&cec_temp_corr_mode=1

Type:float
cec_array_rows

Rows of modules in array

Required: Required if module_model=1&cec_temp_corr_mode=1

Type:float
cec_backside_temp

Module backside temperature [C]

Constraints: POSITIVE

Required: Required if module_model=1&cec_temp_corr_mode=1

Type:float
cec_beta_oc

Open circuit voltage temperature coefficient [V/C]

Required: Required if module_model=1

Type:float
cec_bifacial_ground_clearance_height

Module ground clearance height [m]

Required: Required if module_model=1

Type:float
cec_bifacial_transmission_factor

Bifacial transmission factor [0-1]

Required: Required if module_model=1

Type:float
cec_bifaciality

Bifaciality factor [%]

Required: Required if module_model=1

Type:float
cec_gamma_r

Maximum power point temperature coefficient [%/C]

Required: Required if module_model=1

Type:float
cec_gap_spacing

Gap spacing [m]

Required: Required if module_model=1&cec_temp_corr_mode=1

Type:float
cec_heat_transfer

Heat transfer dimensions

Options: 0=module,1=array

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if module_model=1&cec_temp_corr_mode=1

Type:float
cec_height

Array mounting height

Options: 0=one story,1=two story

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if module_model=1

Type:float
cec_i_l_ref

Light current [A]

Required: Required if module_model=1

Type:float
cec_i_mp_ref

Maximum power point current [A]

Required: Required if module_model=1

The value of the following variables depends on cec_i_mp_ref:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
cec_i_o_ref

Saturation current [A]

Required: Required if module_model=1

Type:float
cec_i_sc_ref

Short circuit current [A]

Required: Required if module_model=1

Type:float
cec_is_bifacial

Modules are bifacial [0/1]

Required: Required if module_model=1

Type:float
cec_module_length

Module height [m]

Required: Required if module_model=1&cec_temp_corr_mode=1

The value of cec_module_length depends on the following variables:

  • cec_area
  • cec_module_width
Type:float
cec_module_width

Module width [m]

Required: Required if module_model=1&cec_temp_corr_mode=1

The value of the following variables depends on cec_module_width:

  • cec_module_length
Type:float
cec_mounting_config

Mounting configuration

Options: 0=rack,1=flush,2=integrated,3=gap

Constraints: INTEGER,MIN=0,MAX=3

Required: Required if module_model=1&cec_temp_corr_mode=1

Type:float
cec_mounting_orientation

Mounting structure orientation

Options: 0=do not impede flow,1=vertical supports,2=horizontal supports

Constraints: INTEGER,MIN=0,MAX=2

Required: Required if module_model=1&cec_temp_corr_mode=1

Type:float
cec_n_s

Number of cells in series

Constraints: POSITIVE

Required: Required if module_model=1

Type:float
cec_r_s

Series resistance [ohm]

Required: Required if module_model=1

Type:float
cec_r_sh_ref

Shunt resistance [ohm]

Required: Required if module_model=1

Type:float
cec_standoff

Standoff mode

Options: 0=bipv,1=>3.5in,2=2.5-3.5in,3=1.5-2.5in,4=0.5-1.5in,5=<0.5in,6=ground/rack

Constraints: INTEGER,MIN=0,MAX=6

Required: Required if module_model=1

Type:float
cec_t_noct

Nominal operating cell temperature [C]

Required: Required if module_model=1

Type:float
cec_temp_corr_mode

Cell temperature model selection

Options: 0=noct,1=mc

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if module_model=1

Type:float
cec_transient_thermal_model_unit_mass

Module unit mass [kg/m^2]

Constraints: POSITIVE

Required: Required if module_model=1

Type:float
cec_v_mp_ref

Maximum power point voltage [V]

Required: Required if module_model=1

The value of the following variables depends on cec_v_mp_ref:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
cec_v_oc_ref

Open circuit voltage [V]

Required: Required if module_model=1

The value of the following variables depends on cec_v_oc_ref:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float

CECPerformanceModelWithUserEnteredSpecifications Group

class PySAM.Pvsamv1.Pvsamv1.CECPerformanceModelWithUserEnteredSpecifications
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

CECPerformanceModelWithUserEnteredSpecifications_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

CECPerformanceModelWithUserEnteredSpecifications_vals = { var: val, ...}

sixpar_aisc

Short circuit current temperature coefficient [A/C]

Required: Required if module_model=2

The value of sixpar_aisc depends on the following variables:

  • 6par_isc
Type:float
sixpar_area

Module area [m2]

Required: Required if module_model=2

Type:float
sixpar_bifacial_ground_clearance_height

Module ground clearance height [m]

Required: Required if module_model=2

Type:float
sixpar_bifacial_transmission_factor

Bifacial transmission factor [0-1]

Required: Required if module_model=2

Type:float
sixpar_bifaciality

Bifaciality factor [%]

Required: Required if module_model=2

Type:float
sixpar_bvoc

Open circuit voltage temperature coefficient [V/C]

Required: Required if module_model=2

The value of sixpar_bvoc depends on the following variables:

  • 6par_voc
Type:float
sixpar_celltech

Solar cell technology type

Options: monoSi=0,multiSi=1,CdTe=2,CIS=3,CIGS=4,Amorphous=5

Constraints: INTEGER,MIN=0,MAX=5

Required: Required if module_model=2

Type:float
sixpar_gpmp

Maximum power point temperature coefficient [%/C]

Required: Required if module_model=2

Type:float
sixpar_imp

Imp [A]

Required: Required if module_model=2

The value of the following variables depends on sixpar_imp:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
sixpar_is_bifacial

Modules are bifacial [0/1]

Required: Required if module_model=2

Type:float
sixpar_isc

Isc [A]

Required: Required if module_model=2

The value of the following variables depends on sixpar_isc:

  • 6par_aisc
Type:float
sixpar_mounting

Array mounting height

Options: 0=one story,1=two story

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if module_model=2

Type:float
sixpar_nser

Nseries

Constraints: INTEGER,POSITIVE

Required: Required if module_model=2

Type:float
sixpar_standoff

Standoff mode

Options: 0=bipv,1=>3.5in,2=2.5-3.5in,3=1.5-2.5in,4=0.5-1.5in,5=<0.5in,6=ground/rack

Constraints: INTEGER,MIN=0,MAX=6

Required: Required if module_model=2

Type:float
sixpar_tnoct

Nominal operating cell temperature [C]

Required: Required if module_model=2

Type:float
sixpar_transient_thermal_model_unit_mass

Module unit mass [kg/m^2]

Required: Required if module_model=2

Type:float
sixpar_vmp

Maximum power point voltage [V]

Required: Required if module_model=2

The value of the following variables depends on sixpar_vmp:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
sixpar_voc

Voc [V]

Required: Required if module_model=2

The value of the following variables depends on sixpar_voc:

  • 6par_bvoc
  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float

SandiaPVArrayPerformanceModelWithModuleDatabase Group

class PySAM.Pvsamv1.Pvsamv1.SandiaPVArrayPerformanceModelWithModuleDatabase
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

SandiaPVArrayPerformanceModelWithModuleDatabase_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

SandiaPVArrayPerformanceModelWithModuleDatabase_vals = { var: val, ...}

snl_a

Temperature coefficient a

Required: Required if module_model=3

The value of the following variables depends on snl_a:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_a0

Air mass polynomial coeff 0

Required: Required if module_model=3

The value of the following variables depends on snl_a0:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_a1

Air mass polynomial coeff 1

Required: Required if module_model=3

The value of the following variables depends on snl_a1:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_a2

Air mass polynomial coeff 2

Required: Required if module_model=3

The value of the following variables depends on snl_a2:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_a3

Air mass polynomial coeff 3

Required: Required if module_model=3

The value of the following variables depends on snl_a3:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_a4

Air mass polynomial coeff 4

Required: Required if module_model=3

The value of the following variables depends on snl_a4:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_aimp

Max power point current temperature coefficient

Required: Required if module_model=3

The value of the following variables depends on snl_aimp:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_aisc

Short circuit current temperature coefficient

Required: Required if module_model=3

The value of the following variables depends on snl_aisc:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_area

Module area

Required: Required if module_model=3

The value of the following variables depends on snl_area:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_b

Temperature coefficient b

Required: Required if module_model=3

The value of the following variables depends on snl_b:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_b0

Incidence angle modifier polynomial coeff 0

Required: Required if module_model=3

The value of the following variables depends on snl_b0:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_b1

Incidence angle modifier polynomial coeff 1

Required: Required if module_model=3

The value of the following variables depends on snl_b1:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_b2

Incidence angle modifier polynomial coeff 2

Required: Required if module_model=3

The value of the following variables depends on snl_b2:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_b3

Incidence angle modifier polynomial coeff 3

Required: Required if module_model=3

The value of the following variables depends on snl_b3:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_b4

Incidence angle modifier polynomial coeff 4

Required: Required if module_model=3

The value of the following variables depends on snl_b4:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_b5

Incidence angle modifier polynomial coeff 5

Required: Required if module_model=3

The value of the following variables depends on snl_b5:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_bvmpo

Max power point voltage temperature coefficient

Required: Required if module_model=3

The value of the following variables depends on snl_bvmpo:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_bvoco

Open circuit voltage temperature coefficient

Required: Required if module_model=3

The value of the following variables depends on snl_bvoco:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_c0

C0

Required: Required if module_model=3

The value of the following variables depends on snl_c0:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_c1

C1

Required: Required if module_model=3

The value of the following variables depends on snl_c1:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_c2

C2

Required: Required if module_model=3

The value of the following variables depends on snl_c2:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_c3

C3

Required: Required if module_model=3

The value of the following variables depends on snl_c3:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_c4

C4

Required: Required if module_model=3

Type:float
snl_c5

C5

Required: Required if module_model=3

Type:float
snl_c6

C6

Required: Required if module_model=3

Type:float
snl_c7

C7

Required: Required if module_model=3

Type:float
snl_dtc

Temperature coefficient dT

Required: Required if module_model=3

The value of the following variables depends on snl_dtc:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_fd

Diffuse fraction

Required: Required if module_model=3

The value of the following variables depends on snl_fd:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_impo

Max power point current

Required: Required if module_model=3

The value of the following variables depends on snl_impo:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_isco

Short circuit current

Required: Required if module_model=3

The value of the following variables depends on snl_isco:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_ixo

Ix midpoint current

Required: Required if module_model=3

Type:float
snl_ixxo

Ixx midpoint current

Required: Required if module_model=3

Type:float
snl_mbvmp

Irradiance dependence of Vmp temperature coefficient

Required: Required if module_model=3

The value of the following variables depends on snl_mbvmp:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_mbvoc

Irradiance dependence of Voc temperature coefficient

Required: Required if module_model=3

The value of the following variables depends on snl_mbvoc:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_module_structure

Module and mounting structure configuration

Options: 0=Use Database Values,1=glass/cell/polymer sheet-open rack,2=glass/cell/glass-open rack,3=polymer/thin film/steel-open rack,4=Insulated back BIPV,5=close roof mount,6=user-defined

Constraints: INTEGER,MIN=0,MAX=6

Required: Required if module_model=3

The value of the following variables depends on snl_module_structure:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_n

Diode factor

Required: Required if module_model=3

The value of the following variables depends on snl_n:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_ref_a

User-specified a

Required: Required if module_model=3

The value of snl_ref_a depends on the following variables:

  • snl_a
  • snl_a0
  • snl_a1
  • snl_a2
  • snl_a3
  • snl_a4
  • snl_aimp
  • snl_aisc
  • snl_area
  • snl_b
  • snl_b0
  • snl_b1
  • snl_b2
  • snl_b3
  • snl_b4
  • snl_b5
  • snl_bvmpo
  • snl_bvoco
  • snl_c0
  • snl_c1
  • snl_c2
  • snl_c3
  • snl_dtc
  • snl_fd
  • snl_impo
  • snl_isco
  • snl_mbvmp
  • snl_mbvoc
  • snl_module_structure
  • snl_n
  • snl_series_cells
  • snl_vmpo
  • snl_voco
Type:float
snl_ref_b

User-specified b

Required: Required if module_model=3

The value of snl_ref_b depends on the following variables:

  • snl_a
  • snl_a0
  • snl_a1
  • snl_a2
  • snl_a3
  • snl_a4
  • snl_aimp
  • snl_aisc
  • snl_area
  • snl_b
  • snl_b0
  • snl_b1
  • snl_b2
  • snl_b3
  • snl_b4
  • snl_b5
  • snl_bvmpo
  • snl_bvoco
  • snl_c0
  • snl_c1
  • snl_c2
  • snl_c3
  • snl_dtc
  • snl_fd
  • snl_impo
  • snl_isco
  • snl_mbvmp
  • snl_mbvoc
  • snl_module_structure
  • snl_n
  • snl_series_cells
  • snl_vmpo
  • snl_voco
Type:float
snl_ref_dT

User-specified dT

Required: Required if module_model=3

The value of snl_ref_dT depends on the following variables:

  • snl_a
  • snl_a0
  • snl_a1
  • snl_a2
  • snl_a3
  • snl_a4
  • snl_aimp
  • snl_aisc
  • snl_area
  • snl_b
  • snl_b0
  • snl_b1
  • snl_b2
  • snl_b3
  • snl_b4
  • snl_b5
  • snl_bvmpo
  • snl_bvoco
  • snl_c0
  • snl_c1
  • snl_c2
  • snl_c3
  • snl_dtc
  • snl_fd
  • snl_impo
  • snl_isco
  • snl_mbvmp
  • snl_mbvoc
  • snl_module_structure
  • snl_n
  • snl_series_cells
  • snl_vmpo
  • snl_voco
Type:float
snl_series_cells

Number of cells in series

Constraints: INTEGER

Required: Required if module_model=3

The value of the following variables depends on snl_series_cells:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_transient_thermal_model_unit_mass

Module unit mass [kg/m^2]

Required: Required if module_model=3

Type:float
snl_vmpo

Max power point voltage

Required: Required if module_model=3

The value of the following variables depends on snl_vmpo:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
snl_voco

Open circuit voltage

Required: Required if module_model=3

The value of the following variables depends on snl_voco:

  • inverter_count
  • snl_ref_a
  • snl_ref_b
  • snl_ref_dT
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float

IEC61853SingleDiodeModel Group

class PySAM.Pvsamv1.Pvsamv1.IEC61853SingleDiodeModel
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

IEC61853SingleDiodeModel_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

IEC61853SingleDiodeModel_vals = { var: val, ...}

sd11par_AMa0

Air mass modifier coeff 0

Required: Required if module_model=4

Type:float
sd11par_AMa1

Air mass modifier coeff 1

Required: Required if module_model=4

Type:float
sd11par_AMa2

Air mass modifier coeff 2

Required: Required if module_model=4

Type:float
sd11par_AMa3

Air mass modifier coeff 3

Required: Required if module_model=4

Type:float
sd11par_AMa4

Air mass modifier coeff 4

Required: Required if module_model=4

Type:float
sd11par_Egref

Bandgap voltage [eV]

Required: Required if module_model=4

Type:float
sd11par_Il

Light current [A]

Required: Required if module_model=4

Type:float
sd11par_Imp0

Imp (STC) [A]

Required: Required if module_model=4

Type:float
sd11par_Io

Saturation current [A]

Required: Required if module_model=4

Type:float
sd11par_Isc0

Isc (STC) [A]

Required: Required if module_model=4

Type:float
sd11par_Vmp0

Vmp (STC) [V]

Required: Required if module_model=4

The value of the following variables depends on sd11par_Vmp0:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
sd11par_Voc0

Voc (STC) [V]

Required: Required if module_model=4

The value of the following variables depends on sd11par_Voc0:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
sd11par_alphaIsc

Short curcuit current temperature coefficient [A/C]

Required: Required if module_model=4

Type:float
sd11par_area

Module area [m2]

Required: Required if module_model=4

Type:float
sd11par_c1

Rsh fit parameter 1

Required: Required if module_model=4

Type:float
sd11par_c2

Rsh fit parameter 2

Required: Required if module_model=4

Type:float
sd11par_c3

Rsh fit parameter 3

Required: Required if module_model=4

Type:float
sd11par_d1

Rs fit parameter 1

Required: Required if module_model=4

Type:float
sd11par_d2

Rs fit parameter 2

Required: Required if module_model=4

Type:float
sd11par_d3

Rs fit parameter 3

Required: Required if module_model=4

Type:float
sd11par_glass

Module cover glass type

Options: 0=normal,1=AR glass

Required: Required if module_model=4

Type:float
sd11par_mounting

Array mounting height

Options: 0=one story,1=two story

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if module_model=4

Type:float
sd11par_n

Diode nonideality factor

Required: Required if module_model=4

Type:float
sd11par_nser

Nseries

Constraints: INTEGER,POSITIVE

Required: Required if module_model=4

Type:float
sd11par_standoff

Standoff mode

Options: 0=bipv,1=>3.5in,2=2.5-3.5in,3=1.5-2.5in,4=0.5-1.5in,5=<0.5in,6=ground/rack

Constraints: INTEGER,MIN=0,MAX=6

Required: Required if module_model=4

Type:float
sd11par_tnoct

Nominal operating cell temperature [C]

Required: Required if module_model=4

Type:float

MermoudLejeuneSingleDiodeModel Group

class PySAM.Pvsamv1.Pvsamv1.MermoudLejeuneSingleDiodeModel
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

MermoudLejeuneSingleDiodeModel_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

MermoudLejeuneSingleDiodeModel_vals = { var: val, ...}

mlm_AM_c_lp0

Coefficient 0 for Lee/Panchula Air Mass Modifier [-]

Required: Required if module_model=5

Type:float
mlm_AM_c_lp1

Coefficient 1 for Lee/Panchula Air Mass Modifier [-]

Required: Required if module_model=5

Type:float
mlm_AM_c_lp2

Coefficient 2 for Lee/Panchula Air Mass Modifier [-]

Required: Required if module_model=5

Type:float
mlm_AM_c_lp3

Coefficient 3 for Lee/Panchula Air Mass Modifier [-]

Required: Required if module_model=5

Type:float
mlm_AM_c_lp4

Coefficient 4 for Lee/Panchula Air Mass Modifier [-]

Required: Required if module_model=5

Type:float
mlm_AM_c_lp5

Coefficient 5 for Lee/Panchula Air Mass Modifier [-]

Required: Required if module_model=5

Type:float
mlm_AM_c_sa0

Coefficient 0 for Sandia Air Mass Modifier [-]

Required: Required if module_model=5

Type:float
mlm_AM_c_sa1

Coefficient 1 for Sandia Air Mass Modifier [-]

Required: Required if module_model=5

Type:float
mlm_AM_c_sa2

Coefficient 2 for Sandia Air Mass Modifier [-]

Required: Required if module_model=5

Type:float
mlm_AM_c_sa3

Coefficient 3 for Sandia Air Mass Modifier [-]

Required: Required if module_model=5

Type:float
mlm_AM_c_sa4

Coefficient 4 for Sandia Air Mass Modifier [-]

Required: Required if module_model=5

Type:float
mlm_AM_mode

Air-mass modifier mode [-]

Options: 1: Do not consider AM effects, 2: Use Sandia polynomial [corr=f(AM)], 3: Use standard coefficients from DeSoto model [corr=f(AM)], 4: Use First Solar polynomial [corr=f(AM, p_wat)]

Required: Required if module_model=5

Type:float
mlm_D2MuTau

Coefficient for recombination losses [V]

Required: Required if module_model=5

Type:float
mlm_E_g

Reference bandgap energy [eV]

Required: Required if module_model=5

Type:float
mlm_IAM_c_as

ASHRAE incidence modifier coefficient b_0 [-]

Required: Required if module_model=5

Type:float
mlm_IAM_c_cs_iamValue

Spline IAM - IAM values [-]

Required: Required if module_model=5

Type:sequence
mlm_IAM_c_cs_incAngle

Spline IAM - Incidence angles [deg]

Required: Required if module_model=5

Type:sequence
mlm_IAM_c_sa0

Sandia IAM coefficient 0 [-]

Required: Required if module_model=5

Type:float
mlm_IAM_c_sa1

Sandia IAM coefficient 1 [-]

Required: Required if module_model=5

Type:float
mlm_IAM_c_sa2

Sandia IAM coefficient 2 [-]

Required: Required if module_model=5

Type:float
mlm_IAM_c_sa3

Sandia IAM coefficient 3 [-]

Required: Required if module_model=5

Type:float
mlm_IAM_c_sa4

Sandia IAM coefficient 4 [-]

Required: Required if module_model=5

Type:float
mlm_IAM_c_sa5

Sandia IAM coefficient 5 [-]

Required: Required if module_model=5

Type:float
mlm_IAM_mode

Incidence Angle Modifier mode [-]

Info: 1: Use ASHRAE formula, 2: Use Sandia polynomial, 3: Use cubic spline with user-supplied data

Required: Required if module_model=5

Type:float
mlm_I_mp_ref

I_mp at STC [A]

Required: Required if module_model=5

Type:float
mlm_I_sc_ref

I_sc at STC [A]

Required: Required if module_model=5

Type:float
mlm_Length

Module length (long side) [m]

Required: Required if module_model=5

Type:float
mlm_N_diodes

Number of diodes [-]

Required: Required if module_model=5

Type:float
mlm_N_parallel

Number of cells in parallel [-]

Required: Required if module_model=5

Type:float
mlm_N_series

Number of cells in series [-]

Required: Required if module_model=5

Type:float
mlm_R_s

Series resistance [V/A]

Required: Required if module_model=5

Type:float
mlm_R_sh0

Rsh,0 [V/A]

Required: Required if module_model=5

Type:float
mlm_R_shexp

Rsh exponential coefficient [-]

Required: Required if module_model=5

Type:float
mlm_R_shref

Reference shunt resistance [V/A]

Required: Required if module_model=5

Type:float
mlm_S_ref

Reference irradiance (Typically 1000W/m²) [W/m²]

Required: Required if module_model=5

Type:float
mlm_T_c_fa_U0

Extended Faiman model U_0 [W/m²K]

Required: Required if module_model=5

Type:float
mlm_T_c_fa_U1

Extended Faiman model U_1 [W/m³sK]

Required: Required if module_model=5

Type:float
mlm_T_c_fa_alpha

Extended Faiman model absorptivity [-]

Required: Required if module_model=5

Type:float
mlm_T_c_no_mounting

NOCT Array mounting height [-]

Options: 0=one story,1=two story

Required: Required if module_model=5

Type:float
mlm_T_c_no_standoff

NOCT standoff mode [-]

Options: 0=bipv,1=>3.5in,2=2.5-3.5in,3=1.5-2.5in,4=0.5-1.5in,5=<0.5in,6=ground/rack

Required: Required if module_model=5

Type:float
mlm_T_c_no_tnoct

NOCT cell temperature [°C]

Required: Required if module_model=5

Type:float
mlm_T_mode

Cell temperature model mode [-]

Info: 1: NOCT

Required: Required if module_model=5

Type:float
mlm_T_ref

Reference temperature (Typically 25°C) [°C]

Required: Required if module_model=5

Type:float
mlm_V_mp_ref

V_mp at STC [V]

Required: Required if module_model=5

Type:float
mlm_V_oc_ref

V_oc at STC [V]

Required: Required if module_model=5

Type:float
mlm_Width

Module width (short side) [m]

Required: Required if module_model=5

Type:float
mlm_alpha_isc

Temperature coefficient for I_sc [A/K]

Required: Required if module_model=5

Type:float
mlm_beta_voc_spec

Temperature coefficient for V_oc [V/K]

Required: Required if module_model=5

Type:float
mlm_bifacial_ground_clearance_height

Module ground clearance height [m]

Required: Required if module_model=5

Type:float
mlm_bifacial_transmission_factor

Bifacial transmission factor [0-1]

Required: Required if module_model=5

Type:float
mlm_bifaciality

Bifaciality factor [%]

Required: Required if module_model=5

Type:float
mlm_groundRelfectionFraction

Ground reflection fraction [-]

Required: Required if module_model=5

Type:float
mlm_is_bifacial

Modules are bifacial [0/1]

Required: Required if module_model=5

Type:float
mlm_mu_n

Temperature coefficient of gamma [1/K]

Required: Required if module_model=5

Type:float
mlm_n_0

Gamma [-]

Required: Required if module_model=5

Type:float

Inverter Group

class PySAM.Pvsamv1.Pvsamv1.Inverter
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

Inverter_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

Inverter_vals = { var: val, ...}

inv_cec_cg_eff_cec

Inverter Coefficient Generator CEC Efficiency [%]

The value of inv_cec_cg_eff_cec depends on the following variables:

  • inv_cec_cg_c0
  • inv_cec_cg_c1
  • inv_cec_cg_c2
  • inv_cec_cg_c3
  • inv_cec_cg_paco
  • inv_cec_cg_pdco
  • inv_cec_cg_psco
  • inv_cec_cg_vdco
Type:float
inv_cec_cg_paco

Inverter Coefficient Generator Max AC Power [Wac]

The value of the following variables depends on inv_cec_cg_paco:

  • inv_cec_cg_eff_cec
  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
inv_ds_eff

Inverter Datasheet Efficiency [%]

Type:float
inv_ds_paco

Inverter Datasheet Maximum AC Power [Wac]

The value of the following variables depends on inv_ds_paco:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
inv_num_mppt

Number of MPPT inputs

Constraints: INTEGER,MIN=0,MAX=4

Required: False. Automatically set to 1 if not assigned explicitly or loaded from defaults.

The value of inv_num_mppt depends on the following variables:

  • inverter_model
Type:float
inv_pd_eff

Inverter Partload Efficiency [%]

The value of the following variables depends on inv_pd_eff:

  • inv_pd_pdco
Type:float
inv_pd_paco

Inverter Partload Maximum AC Power [Wac]

The value of the following variables depends on inv_pd_paco:

  • inv_pd_pdco
  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
inv_snl_eff_cec

Inverter Sandia CEC Efficiency [%]

The value of inv_snl_eff_cec depends on the following variables:

  • inv_snl_c0
  • inv_snl_c1
  • inv_snl_c2
  • inv_snl_c3
  • inv_snl_paco
  • inv_snl_pdco
  • inv_snl_pso
  • inv_snl_vdco
Type:float
inv_snl_paco

Inverter Sandia Maximum AC Power [Wac]

The value of the following variables depends on inv_snl_paco:

  • inv_snl_eff_cec
  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
inverter_count

Number of inverters

The value of inverter_count depends on the following variables:

  • 6par_imp
  • 6par_vmp
  • 6par_voc
  • cec_i_mp_ref
  • cec_v_mp_ref
  • cec_v_oc_ref
  • inv_cec_cg_paco
  • inv_cec_cg_vdcmax
  • inv_ds_paco
  • inv_ds_vdcmax
  • inv_pd_paco
  • inv_pd_vdcmax
  • inv_snl_paco
  • inv_snl_vdcmax
  • inverter_model
  • module_model
  • sd11par_Vmp0
  • sd11par_Voc0
  • snl_a
  • snl_a0
  • snl_a1
  • snl_a2
  • snl_a3
  • snl_a4
  • snl_aimp
  • snl_aisc
  • snl_area
  • snl_b
  • snl_b0
  • snl_b1
  • snl_b2
  • snl_b3
  • snl_b4
  • snl_b5
  • snl_bvmpo
  • snl_bvoco
  • snl_c0
  • snl_c1
  • snl_c2
  • snl_c3
  • snl_dtc
  • snl_fd
  • snl_impo
  • snl_isco
  • snl_mbvmp
  • snl_mbvoc
  • snl_module_structure
  • snl_n
  • snl_series_cells
  • snl_vmpo
  • snl_voco
  • spe_area
  • spe_eff0
  • spe_eff1
  • spe_eff2
  • spe_eff3
  • spe_eff4
  • spe_rad0
  • spe_rad1
  • spe_rad2
  • spe_rad3
  • spe_rad4
  • spe_reference
  • spe_vmp
  • spe_voc
Type:float
inverter_model

Inverter model specifier

Options: 0=cec,1=datasheet,2=partload,3=coefficientgenerator,4=PVYield

Constraints: INTEGER,MIN=0,MAX=4

Required: True

The value of the following variables depends on inverter_model:

  • inv_num_mppt
  • inverter_count
  • mppt_hi_inverter
  • mppt_low_inverter
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
mppt_hi_inverter

Maximum inverter MPPT voltage window [Vdc]

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

The value of mppt_hi_inverter depends on the following variables:

  • inverter_model
Type:float
mppt_low_inverter

Minimum inverter MPPT voltage window [Vdc]

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

The value of mppt_low_inverter depends on the following variables:

  • inverter_model
Type:float

InverterCECDatabase Group

class PySAM.Pvsamv1.Pvsamv1.InverterCECDatabase
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

InverterCECDatabase_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

InverterCECDatabase_vals = { var: val, ...}

inv_snl_c0

Curvature between AC power and DC power at ref [1/W]

Required: Required if inverter_model=0

The value of the following variables depends on inv_snl_c0:

  • inv_snl_eff_cec
Type:float
inv_snl_c1

Coefficient of Pdco variation with DC input voltage [1/V]

Required: Required if inverter_model=0

The value of the following variables depends on inv_snl_c1:

  • inv_snl_eff_cec
Type:float
inv_snl_c2

Coefficient of Pso variation with DC input voltage [1/V]

Required: Required if inverter_model=0

The value of the following variables depends on inv_snl_c2:

  • inv_snl_eff_cec
Type:float
inv_snl_c3

Coefficient of Co variation with DC input voltage [1/V]

Required: Required if inverter_model=0

The value of the following variables depends on inv_snl_c3:

  • inv_snl_eff_cec
Type:float
inv_snl_paco

AC maximum power rating [Wac]

Required: Required if inverter_model=0

The value of the following variables depends on inv_snl_paco:

  • inv_snl_eff_cec
  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
inv_snl_pdco

DC input power at which AC power rating is achieved [Wdc]

Required: Required if inverter_model=0

The value of the following variables depends on inv_snl_pdco:

  • inv_snl_eff_cec
Type:float
inv_snl_pnt

AC power consumed by inverter at night [Wac]

Required: Required if inverter_model=0

Type:float
inv_snl_pso

DC power required to enable the inversion process [Wdc]

Required: Required if inverter_model=0

The value of the following variables depends on inv_snl_pso:

  • inv_snl_eff_cec
Type:float
inv_snl_vdcmax

Maximum DC input operating voltage [Vdc]

Required: Required if inverter_model=0

The value of the following variables depends on inv_snl_vdcmax:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
inv_snl_vdco

DC input voltage for the rated AC power rating [Vdc]

Required: Required if inverter_model=0

The value of the following variables depends on inv_snl_vdco:

  • inv_snl_eff_cec
Type:float
inv_tdc_cec_db

Temperature derate curves for CEC Database [(Vdc, C, %/C)]

Required: Required if inverter_model=0

Type:sequence[sequence]

InverterCECCoefficientGenerator Group

class PySAM.Pvsamv1.Pvsamv1.InverterCECCoefficientGenerator
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

InverterCECCoefficientGenerator_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

InverterCECCoefficientGenerator_vals = { var: val, ...}

inv_cec_cg_c0

Curvature between AC power and DC power at ref [1/W]

Required: Required if inverter_model=3

The value of the following variables depends on inv_cec_cg_c0:

  • inv_cec_cg_eff_cec
Type:float
inv_cec_cg_c1

Coefficient of Pdco variation with DC input voltage [1/V]

Required: Required if inverter_model=3

The value of the following variables depends on inv_cec_cg_c1:

  • inv_cec_cg_eff_cec
Type:float
inv_cec_cg_c2

Coefficient of Pso variation with DC input voltage [1/V]

Required: Required if inverter_model=3

The value of the following variables depends on inv_cec_cg_c2:

  • inv_cec_cg_eff_cec
Type:float
inv_cec_cg_c3

Coefficient of Co variation with DC input voltage [1/V]

Required: Required if inverter_model=3

The value of the following variables depends on inv_cec_cg_c3:

  • inv_cec_cg_eff_cec
Type:float
inv_cec_cg_paco

AC maximum power rating [Wac]

Required: Required if inverter_model=3

The value of the following variables depends on inv_cec_cg_paco:

  • inv_cec_cg_eff_cec
  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
inv_cec_cg_pdco

DC input power at which AC power rating is achieved [Wdc]

Required: Required if inverter_model=3

The value of the following variables depends on inv_cec_cg_pdco:

  • inv_cec_cg_eff_cec
Type:float
inv_cec_cg_pnt

AC power consumed by inverter at night [Wac]

Required: Required if inverter_model=3

Type:float
inv_cec_cg_psco

DC power required to enable the inversion process [Wdc]

Required: Required if inverter_model=3

The value of the following variables depends on inv_cec_cg_psco:

  • inv_cec_cg_eff_cec
Type:float
inv_cec_cg_vdcmax

Maximum DC input operating voltage [Vdc]

Required: Required if inverter_model=3

The value of the following variables depends on inv_cec_cg_vdcmax:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
inv_cec_cg_vdco

DC input voltage for the rated AC power rating [Vdc]

Required: Required if inverter_model=3

The value of the following variables depends on inv_cec_cg_vdco:

  • inv_cec_cg_eff_cec
Type:float
inv_tdc_cec_cg

Temperature derate curves for CEC Coef Gen [(Vdc, C, %/C)]

Required: Required if inverter_model=3

Type:sequence[sequence]

InverterDatasheet Group

class PySAM.Pvsamv1.Pvsamv1.InverterDatasheet
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

InverterDatasheet_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

InverterDatasheet_vals = { var: val, ...}

inv_ds_eff

Weighted or Peak or Nominal Efficiency [Wdc]

Required: Required if inverter_model=1

Type:float
inv_ds_paco

AC maximum power rating [Wac]

Required: Required if inverter_model=1

The value of the following variables depends on inv_ds_paco:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
inv_ds_pnt

AC power consumed by inverter at night [Wac]

Required: Required if inverter_model=1

Type:float
inv_ds_pso

DC power required to enable the inversion process [Wdc]

Required: Required if inverter_model=1

Type:float
inv_ds_vdcmax

Maximum DC input operating voltage [Vdc]

Required: Required if inverter_model=1

The value of the following variables depends on inv_ds_vdcmax:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
inv_ds_vdco

DC input voltage for the rated AC power rating [Vdc]

Required: Required if inverter_model=1

Type:float
inv_tdc_ds

Temperature derate curves for Inv Datasheet [(Vdc, C, %/C)]

Required: Required if inverter_model=1

Type:sequence[sequence]

InverterPartLoadCurve Group

class PySAM.Pvsamv1.Pvsamv1.InverterPartLoadCurve
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

InverterPartLoadCurve_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

InverterPartLoadCurve_vals = { var: val, ...}

inv_pd_efficiency

Partload curve efficiency values [%]

Required: Required if inverter_model=2

Type:sequence
inv_pd_paco

AC maximum power rating [Wac]

Required: Required if inverter_model=2

The value of the following variables depends on inv_pd_paco:

  • inv_pd_pdco
  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
inv_pd_partload

Partload curve partload values [%]

Required: Required if inverter_model=2

Type:sequence
inv_pd_pdco

DC input power at which AC power rating is achieved [Wdc]

Required: Required if inverter_model=2

The value of inv_pd_pdco depends on the following variables:

  • inv_pd_eff
  • inv_pd_paco
Type:float
inv_pd_pnt

AC power consumed by inverter at night [Wac]

Required: Required if inverter_model=2

Type:float
inv_pd_vdcmax

Maximum DC input operating voltage [Vdc]

Required: Required if inverter_model=2

The value of the following variables depends on inv_pd_vdcmax:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
inv_pd_vdco

DC input voltage for the rated AC power rating [Vdc]

Required: Required if inverter_model=2

Type:float
inv_tdc_plc

Temperature derate curves for Part Load Curve [(Vdc, C, %/C)]

Required: Required if inverter_model=2

Type:sequence[sequence]

InverterMermoudLejeuneModel Group

class PySAM.Pvsamv1.Pvsamv1.InverterMermoudLejeuneModel
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

InverterMermoudLejeuneModel_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

InverterMermoudLejeuneModel_vals = { var: val, ...}

ond_Aux_Loss

[W]

Required: Required if inverter_model=4

Type:float
ond_CompPMax

[-]

Required: Required if inverter_model=4

Type:str
ond_CompVMax

[-]

Required: Required if inverter_model=4

Type:str
ond_IMaxAC

[A]

Required: Required if inverter_model=4

Type:float
ond_IMaxDC

[A]

Required: Required if inverter_model=4

Type:float
ond_INomAC

[A]

Required: Required if inverter_model=4

Type:float
ond_INomDC

[A]

Required: Required if inverter_model=4

Type:float
ond_ModeAffEnum

[-]

Required: Required if inverter_model=4

Type:str
ond_ModeOper

[-]

Required: Required if inverter_model=4

Type:str
ond_NbInputs

[-]

Required: Required if inverter_model=4

Type:float
ond_NbMPPT

[-]

Required: Required if inverter_model=4

Type:float
ond_Night_Loss

[W]

Required: Required if inverter_model=4

Type:float
ond_PLim1

[W]

Required: Required if inverter_model=4

Type:float
ond_PLimAbs

[W]

Required: Required if inverter_model=4

Type:float
ond_PMaxDC

[W]

Required: Required if inverter_model=4

Type:float
ond_PMaxOUT

[W]

Required: Required if inverter_model=4

Type:float
ond_PNomConv

[W]

Required: Required if inverter_model=4

Type:float
ond_PNomDC

[W]

Required: Required if inverter_model=4

Type:float
ond_PSeuil

[W]

Required: Required if inverter_model=4

Type:float
ond_TPLim1

[°C]

Required: Required if inverter_model=4

Type:float
ond_TPLimAbs

[°C]

Required: Required if inverter_model=4

Type:float
ond_TPMax

[°C]

Required: Required if inverter_model=4

Type:float
ond_TPNom

[°C]

Required: Required if inverter_model=4

Type:float
ond_VAbsMax

[V]

Required: Required if inverter_model=4

Type:float
ond_VMPPMax

[V]

Required: Required if inverter_model=4

Type:float
ond_VMppMin

[V]

Required: Required if inverter_model=4

Type:float
ond_VNomEff

[V]

Required: Required if inverter_model=4

Type:sequence
ond_VOutConv

[W]

Required: Required if inverter_model=4

Type:float
ond_doAllowOverpower

[-]

Required: Required if inverter_model=4

Type:float
ond_doUseTemperatureLimit

[-]

Required: Required if inverter_model=4

Type:float
ond_effCurve_Pac

[W]

Required: Required if inverter_model=4

Type:sequence[sequence]
ond_effCurve_Pdc

[W]

Required: Required if inverter_model=4

Type:sequence[sequence]
ond_effCurve_elements

[-]

Required: Required if inverter_model=4

Type:float
ond_effCurve_eta

[-]

Required: Required if inverter_model=4

Type:sequence[sequence]
ond_lossRAc

[A]

Required: Required if inverter_model=4

Type:float
ond_lossRDc

[V/A]

Required: Required if inverter_model=4

Type:float

BatterySystem Group

class PySAM.Pvsamv1.Pvsamv1.BatterySystem
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

BatterySystem_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

BatterySystem_vals = { var: val, ...}

batt_ac_dc_efficiency

Inverter AC to battery DC efficiency

Type:float
batt_ac_or_dc

Battery interconnection (AC or DC)

Options: 0=DC_Connected,1=AC_Connected

The value of the following variables depends on batt_ac_or_dc:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
batt_computed_bank_capacity

Battery computed bank capacity [kWh]

Type:float
batt_computed_series

Battery number of cells in series

Type:float
batt_computed_strings

Battery number of strings of cells

Type:float
batt_current_charge_max

Battery maximum charge current [A]

Type:float
batt_current_choice

Limit cells by current or power

Type:float
batt_current_discharge_max

Battery maximum discharge current [A]

Type:float
batt_dc_ac_efficiency

Battery DC to AC efficiency

Type:float
batt_dc_dc_efficiency

System DC to battery DC efficiency

Type:float
batt_inverter_efficiency_cutoff

Inverter efficiency at which to cut battery charge or discharge off [%]

Type:float
batt_loss_choice

Loss power input option [0/1]

Options: 0=Monthly,1=TimeSeries

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
batt_losses

Battery system losses at each timestep (kW DC for DC connected, AC for AC connected) [kW]

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:sequence
batt_losses_charging

Battery system losses when charging (kW DC for DC connected, AC for AC connected) [kW]

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:sequence
batt_losses_discharging

Battery system losses when discharging (kW DC for DC connected, AC for AC connected) [kW]

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:sequence
batt_losses_idle

Battery system losses when idle (kW DC for DC connected, AC for AC connected) [kW]

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:sequence
batt_mass

Battery mass [kg]

Type:float
batt_meter_position

Position of battery relative to electric meter

Options: 0=BehindTheMeter,1=FrontOfMeter

Type:float
batt_power_charge_max_kwac

Battery maximum charge power (AC) [kWac]

Type:float
batt_power_charge_max_kwdc

Battery maximum charge power (DC) [kWdc]

Type:float
batt_power_discharge_max_kwac

Battery maximum discharge power (AC) [kWac]

Type:float
batt_power_discharge_max_kwdc

Battery maximum discharge power (DC) [kWdc]

The value of the following variables depends on batt_power_discharge_max_kwdc:

  • inverter_count
  • subarray1_modules_per_string
  • subarray1_nstrings
  • subarray2_enable
  • subarray3_enable
  • subarray4_enable
  • system_capacity
Type:float
batt_replacement_capacity

Capacity degradation at which to replace battery [%]

Type:float
batt_replacement_option

Enable battery replacement? [0=none,1=capacity based,2=user schedule]

Constraints: INTEGER,MIN=0,MAX=2

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
batt_replacement_schedule_percent

Percentage of battery capacity to replace in each year [%]

Options: length <= analysis_period

Required: Required if batt_replacement_option=2

Type:sequence
batt_surface_area

Battery surface area [m^2]

Type:float
en_batt

Enable battery storage model [0/1]

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
en_standalone_batt

Enable standalone battery storage model [0/1]

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
om_replacement_cost1

Cost to replace battery per kWh [$/kWh]

Type:sequence

Load Group

class PySAM.Pvsamv1.Pvsamv1.Load
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

Load_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

Load_vals = { var: val, ...}

crit_load

Critical Electricity load (year 1) [kW]

Type:sequence
crit_load_escalation

Annual critical load escalation [%/year]

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:sequence
grid_outage

Grid outage in this time step [0/1]

Options: 0=GridAvailable,1=GridUnavailable,Length=load

Type:sequence
load

Electricity load (year 1) [kW]

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
run_resiliency_calcs

Enable resilence calculations for every timestep [0/1]

Options: 0=DisableCalcs,1=EnableCalcs

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float

BatteryCell Group

class PySAM.Pvsamv1.Pvsamv1.BatteryCell
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

BatteryCell_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

BatteryCell_vals = { var: val, ...}

LeadAcid_q10_computed

Capacity at 10-hour discharge rate [Ah]

Type:float
LeadAcid_q20_computed

Capacity at 20-hour discharge rate [Ah]

Type:float
LeadAcid_qn_computed

Capacity at discharge rate for n-hour rate [Ah]

Type:float
LeadAcid_tn

Time to discharge [h]

Type:float
batt_C_rate

Rate at which voltage vs. capacity curve input

Type:float
batt_Cp

Battery specific heat capacity [J/KgK]

Type:float
batt_Qexp

Cell capacity at end of exponential zone [Ah]

Type:float
batt_Qfull

Fully charged cell capacity [Ah]

Type:float
batt_Qfull_flow

Fully charged flow battery capacity [Ah]

Type:float
batt_Qnom

Cell capacity at end of nominal zone [Ah]

Type:float
batt_Vcut

Cutoff voltage for battery rated capacity [V]

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
batt_Vexp

Cell voltage at end of exponential zone [V]

Type:float
batt_Vfull

Fully charged cell voltage [V]

Type:float
batt_Vnom

Cell voltage at end of nominal zone [V]

Type:float
batt_Vnom_default

Default nominal cell voltage [V]

Type:float
batt_calendar_a

Calendar life model coefficient [1/sqrt(day)]

Required: Required if en_batt=1&batt_life_model=0&batt_calendar_choice=1

Type:float
batt_calendar_b

Calendar life model coefficient [K]

Required: Required if en_batt=1&batt_life_model=0&batt_calendar_choice=1

Type:float
batt_calendar_c

Calendar life model coefficient [K]

Required: Required if en_batt=1&batt_life_model=0&batt_calendar_choice=1

Type:float
batt_calendar_choice

Calendar life degradation input option [0/1/2]

Options: 0=NoCalendarDegradation,1=LithiomIonModel,2=InputLossTable

Required: Required if en_batt=1&batt_life_model=0

Type:float
batt_calendar_lifetime_matrix

Days vs capacity

Required: Required if en_batt=1&batt_life_model=0&batt_calendar_choice=2

Type:sequence[sequence]
batt_calendar_q0

Calendar life model initial capacity cofficient

Required: Required if en_batt=1&batt_life_model=0&batt_calendar_choice=1

Type:float
batt_chem

Battery chemistry

Options: 0=LeadAcid,1=LiIon

Type:float
batt_h_to_ambient

Heat transfer between battery and environment [W/m2K]

Type:float
batt_initial_SOC

Initial state-of-charge [%]

Type:float
batt_life_model

Battery life model specifier [0/1/2]

Options: 0=calendar/cycle,1=NMC,2=LMO/LTO

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
batt_lifetime_matrix

Cycles vs capacity at different depths-of-discharge

Required: Required if en_batt=1&batt_life_model=0

Type:sequence[sequence]
batt_maximum_SOC

Maximum allowed state-of-charge [%]

Type:float
batt_minimum_SOC

Minimum allowed state-of-charge during nominal operation [%]

Type:float
batt_minimum_modetime

Minimum time at charge state [min]

Type:float
batt_minimum_outage_SOC

Minimum allowed state-of-charge during an outage [%]

Type:float
batt_resistance

Internal resistance [Ohm]

Type:float
batt_room_temperature_celsius

Temperature of storage room [C]

Options: length=1 for fixed, # of weatherfile records otherwise

Type:sequence
batt_voltage_choice

Battery voltage input option [0/1]

Options: 0=UseVoltageModel,1=InputVoltageTable

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
batt_voltage_matrix

Battery voltage vs. depth-of-discharge

Type:sequence[sequence]
cap_vs_temp

Effective capacity as function of temperature [C,%]

Type:sequence[sequence]

BatteryDispatch Group

class PySAM.Pvsamv1.Pvsamv1.BatteryDispatch
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

BatteryDispatch_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

BatteryDispatch_vals = { var: val, ...}

batt_custom_dispatch

Custom battery power for every time step [kW]

Info: kWAC if AC-connected, else kWDC

Required: Required if en_batt=1&en_standalone_batt=0&batt_dispatch_choice=2

Type:sequence
batt_cycle_cost

Input battery cycle degradaton penalty per year [$/cycle-kWh]

Info: length 1 or analysis_period, length 1 will be extended using inflation

Required: Required if batt_cycle_cost_choice=1

Type:sequence
batt_cycle_cost_choice

Use SAM cost model for degradaton penalty or input custom via batt_cycle_cost [0/1]

Options: 0=UseCostModel,1=InputCost

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
batt_dispatch_auto_btm_can_discharge_to_grid

Behind the meter battery can discharge to grid? [0/1]

Type:float
batt_dispatch_auto_can_charge

System charging allowed for automated dispatch? [0/1]

Type:float
batt_dispatch_auto_can_clipcharge

Battery can charge from clipped power? [0/1]

Type:float
batt_dispatch_auto_can_fuelcellcharge

Charging from fuel cell allowed for automated dispatch? [0/1]

Type:float
batt_dispatch_auto_can_gridcharge

Grid charging allowed for automated dispatch? [0/1]

Type:float
batt_dispatch_charge_only_system_exceeds_load

Battery can charge from system only when system output exceeds load [0/1]

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=0

Type:float
batt_dispatch_choice

Battery dispatch algorithm [0/1/2/3/4]

Options: If behind the meter: 0=PeakShaving,1=InputGridTarget,2=InputBatteryPower,3=ManualDispatch,4=PriceSignalForecast if front of meter: 0=AutomatedEconomic,1=PV_Smoothing,2=InputBatteryPower,3=ManualDispatch

Required: Required if en_batt=1

Type:float
batt_dispatch_discharge_only_load_exceeds_system

Battery can discharge battery only when load exceeds system output [0/1]

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=0

Type:float
batt_dispatch_load_forecast_choice

Load forecast choice for automatic dispatch [0/1/2]

Options: 0=LookAhead,1=LookBehind,2=InputForecast

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
batt_dispatch_pvs_ac_lb

AC lower bound [fraction of nameplate]

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=1&batt_dispatch_choice=1

Type:float
batt_dispatch_pvs_ac_lb_enable

Enable AC lower bound [0/1]

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=1&batt_dispatch_choice=1

Type:float
batt_dispatch_pvs_ac_ub

AC upper bound [fraction of nameplate]

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=1&batt_dispatch_choice=1

Type:float
batt_dispatch_pvs_ac_ub_enable

Enable AC upper bound [0/1]

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=1&batt_dispatch_choice=1

Type:float
batt_dispatch_pvs_curtail_as_control

Correct up-ramp violations [0/1]

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=1&batt_dispatch_choice=1

Type:float
batt_dispatch_pvs_curtail_if_violation

Curtail violations [0/1]

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=1&batt_dispatch_choice=1

Type:float
batt_dispatch_pvs_forecast_shift_periods

Forecasting window [periods of ramp intervals]

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=1&batt_dispatch_choice=1

Type:float
batt_dispatch_pvs_kf

Forecast accumulation error multiplier (kf)

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=1&batt_dispatch_choice=1

Type:float
batt_dispatch_pvs_ki

Return to rest SOC multiplier (ki)

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=1&batt_dispatch_choice=1

Type:float
batt_dispatch_pvs_kp

Track PV power multiplier (kp)

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=1&batt_dispatch_choice=1

Type:float
batt_dispatch_pvs_max_ramp

Maximum ramp rate [% of nameplate per ramp interval]

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=1&batt_dispatch_choice=1

Type:float
batt_dispatch_pvs_nameplate_ac

Nameplate for pv smoothing [kWac]

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=1&batt_dispatch_choice=1

Type:float
batt_dispatch_pvs_short_forecast_enable

Enable short term power forecast [0/1]

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=1&batt_dispatch_choice=1

Type:float
batt_dispatch_pvs_soc_rest

Battery resting SOC [%]

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=1&batt_dispatch_choice=1

Type:float
batt_dispatch_pvs_timestep_multiplier

Ramp timestep multiplier

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=1&batt_dispatch_choice=1

Type:float
batt_dispatch_update_frequency_hours

Frequency to update the look-ahead dispatch [hours]

Type:float
batt_dispatch_wf_forecast_choice

Weather forecast choice for automatic dispatch [0/1/2]

Options: 0=LookAhead,1=LookBehind,2=InputForecast

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
batt_load_ac_forecast

Load ac power forecast [kW]

Info: Length either 8760 or 8760 * steps per hour

Type:sequence
batt_load_ac_forecast_escalation

Annual load escalation for ac power forecast [kW]

Options: length <= analysis_period

Type:sequence
batt_look_ahead_hours

Hours to look ahead in automated dispatch [hours]

Type:float
batt_pv_ac_forecast

PV ac power forecast [kW]

Info: Length either 8760 * steps per hour (values repeat each year) or 8760 * steps per hour * analysis period

Type:sequence
batt_pv_clipping_forecast

PV clipping forecast [kW]

Info: Length either 8760 * steps per hour (values repeat each year) or 8760 * steps per hour * analysis period

Type:sequence
batt_target_choice

Target power input option [0/1]

Options: 0=InputMonthlyTarget,1=InputFullTimeSeries

Required: Required if en_batt=1&en_standalone_batt=0&batt_meter_position=0&batt_dispatch_choice=1

Type:float
batt_target_power

Grid target power for every time step [kW]

Required: Required if en_batt=1&batt_meter_position=0&batt_dispatch_choice=1

Type:sequence
batt_target_power_monthly

Grid target power on monthly basis [kW]

Required: Required if en_batt=1&batt_meter_position=0&batt_dispatch_choice=1

Type:sequence
dispatch_manual_btm_discharge_to_grid

Periods 1-6 behind the meter discharging to grid allowed?

Required: Required if en_batt=1&batt_dispatch_choice=3&batt_meter_position=0

Type:sequence
dispatch_manual_charge

Periods 1-6 charging from system allowed?

Required: Required if en_batt=1&en_standalone_batt=0&batt_dispatch_choice=3

Type:sequence
dispatch_manual_discharge

Periods 1-6 discharging allowed?

Required: Required if en_batt=1&batt_dispatch_choice=3

Type:sequence
dispatch_manual_fuelcellcharge

Periods 1-6 charging from fuel cell allowed?

Type:sequence
dispatch_manual_gridcharge

Periods 1-6 grid charging allowed?

Required: Required if en_batt=1&batt_dispatch_choice=3

Type:sequence
dispatch_manual_percent_discharge

Periods 1-6 discharge percent [%]

Required: Required if en_batt=1&batt_dispatch_choice=3

Type:sequence
dispatch_manual_percent_gridcharge

Periods 1-6 gridcharge percent [%]

Required: Required if en_batt=1&batt_dispatch_choice=3

Type:sequence
dispatch_manual_sched

Battery dispatch schedule for weekday

Required: Required if en_batt=1&batt_dispatch_choice=3

Type:sequence[sequence]
dispatch_manual_sched_weekend

Battery dispatch schedule for weekend

Required: Required if en_batt=1&batt_dispatch_choice=3

Type:sequence[sequence]

SystemCosts Group

class PySAM.Pvsamv1.Pvsamv1.SystemCosts
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

SystemCosts_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

SystemCosts_vals = { var: val, ...}

om_batt_replacement_cost

Replacement cost 1 [$/kWh]

Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.

Type:sequence
om_replacement_cost_escal

Replacement cost escalation [%/year]

Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.

Type:float

FuelCell Group

class PySAM.Pvsamv1.Pvsamv1.FuelCell
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

FuelCell_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

FuelCell_vals = { var: val, ...}

fuelcell_power

Electricity from fuel cell [kW]

Type:sequence

PriceSignal Group

class PySAM.Pvsamv1.Pvsamv1.PriceSignal
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

PriceSignal_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

PriceSignal_vals = { var: val, ...}

dispatch_factors_ts

Dispatch payment factor time step

Required: Required if forecast_price_signal_model=0&en_batt=1&batt_meter_position=1&ppa_multiplier_model=1

Type:sequence
dispatch_sched_weekday

Diurnal weekday TOD periods [1..9]

Info: 12 x 24 matrix

Required: Required if en_batt=1&batt_meter_position=1&forecast_price_signal_model=0&ppa_multiplier_model=0

Type:sequence[sequence]
dispatch_sched_weekend

Diurnal weekend TOD periods [1..9]

Info: 12 x 24 matrix

Required: Required if en_batt=1&batt_meter_position=1&forecast_price_signal_model=0&ppa_multiplier_model=0

Type:sequence[sequence]
dispatch_tod_factors

TOD factors for periods 1-9

Required: Required if en_batt=1&batt_meter_position=1&forecast_price_signal_model=0&ppa_multiplier_model=0

Type:sequence
forecast_price_signal_model

Forecast price signal model selected [0/1]

Options: 0=PPA based,1=Merchant Plant

Constraints: INTEGER,MIN=0,MAX=1

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
mp_ancserv1_revenue

Ancillary services 1 revenue input [ [MW, $/MW]]

Required: Required if en_batt=1&batt_meter_position=1&forecast_price_signal_model=1

Type:sequence[sequence]
mp_ancserv2_revenue

Ancillary services 2 revenue input [ [MW, $/MW]]

Required: Required if en_batt=1&batt_meter_position=1&forecast_price_signal_model=1

Type:sequence[sequence]
mp_ancserv3_revenue

Ancillary services 3 revenue input [ [MW, $/MW]]

Required: Required if en_batt=1&batt_meter_position=1&forecast_price_signal_model=1

Type:sequence[sequence]
mp_ancserv4_revenue

Ancillary services 4 revenue input [ [MW, $/MW]]

Required: Required if en_batt=1&batt_meter_position=1&forecast_price_signal_model=1

Type:sequence[sequence]
mp_enable_ancserv1

Enable ancillary services 1 revenue [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if forecast_price_signal_model=1

Type:float
mp_enable_ancserv2

Enable ancillary services 2 revenue [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if forecast_price_signal_model=1

Type:float
mp_enable_ancserv3

Enable ancillary services 3 revenue [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if forecast_price_signal_model=1

Type:float
mp_enable_ancserv4

Enable ancillary services 4 revenue [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if forecast_price_signal_model=1

Type:float
mp_enable_energy_market_revenue

Enable energy market revenue [0/1]

Options: 0=false,1=true

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if en_batt=1&batt_meter_position=1&forecast_price_signal_model=1

Type:float
mp_energy_market_revenue

Energy market revenue input [ [MW, $/MW]]

Required: Required if en_batt=1&batt_meter_position=1&forecast_price_signal_model=1

Type:sequence[sequence]
ppa_escalation

PPA escalation rate [%/year]

Required: Required if forecast_price_signal_model=0&en_batt=1&batt_meter_position=1

Type:float
ppa_multiplier_model

PPA multiplier model [0/1]

Options: 0=diurnal,1=timestep

Constraints: INTEGER,MIN=0

Required: Required if forecast_price_signal_model=0&en_batt=1&batt_meter_position=1

Type:float
ppa_price_input

PPA Price Input [$/kWh]

Required: Required if forecast_price_signal_model=0&en_batt=1&batt_meter_position=1

Type:sequence

Revenue Group

class PySAM.Pvsamv1.Pvsamv1.Revenue
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

Revenue_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

Revenue_vals = { var: val, ...}

mp_ancserv1_revenue_single

Ancillary services 1 revenue input

Info: Lifetime x 1[Price($/MWh)]

Required: Required if forecast_price_signal_model=1&mp_enable_ancserv1_percent_gen=1

Type:sequence[sequence]
mp_ancserv2_revenue_single

Ancillary services 2 revenue input

Info: Lifetime x 1[Price($/MWh)]

Required: Required if forecast_price_signal_model=1&mp_enable_ancserv2_percent_gen=1

Type:sequence[sequence]
mp_ancserv3_revenue_single

Ancillary services 3 revenue input

Info: Lifetime x 1[Price($/MWh)]

Required: Required if forecast_price_signal_model=1&mp_enable_ancserv3_percent_gen=1

Type:sequence[sequence]
mp_ancserv4_revenue_single

Ancillary services 4 revenue input

Info: Lifetime x 1[Price($/MWh)]

Required: Required if forecast_price_signal_model=1&mp_enable_ancserv4_percent_gen=1

Type:sequence[sequence]
mp_enable_ancserv1_percent_gen

Enable percent demand cleared capacity option for ancillary service 1 [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if forecast_price_signal_model=1

Type:float
mp_enable_ancserv2_percent_gen

Enable percent demand cleared capacity option for ancillary service 2 [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if forecast_price_signal_model=1

Type:float
mp_enable_ancserv3_percent_gen

Enable percent demand cleared capacity option for ancillary service 3 [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if forecast_price_signal_model=1

Type:float
mp_enable_ancserv4_percent_gen

Enable percent demand cleared capacity option for ancillary service 4 [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if forecast_price_signal_model=1

Type:float
mp_enable_market_percent_gen

Enable percent demand cleared capacity option for market revenue [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: Required if forecast_price_signal_model=1

Type:float
mp_energy_market_revenue_single

Energy market revenue input

Info: Lifetime x 1 [Price($/MWh)]

Required: Required if forecast_price_signal_model=1&mp_enable_market_percent_gen=1

Type:sequence[sequence]

ElectricityRates Group

class PySAM.Pvsamv1.Pvsamv1.ElectricityRates
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

ElectricityRates_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

ElectricityRates_vals = { var: val, ...}

rate_escalation

Annual electricity rate escalation [%/year]

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:sequence
ur_annual_min_charge

Annual minimum charge [$]

Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.

Type:float
ur_billing_demand_lookback_percentages

Billing demand lookback percentages by month and consider actual peak demand

Info: 12x2

Required: Required if ur_enable_billing_demand=1

Type:sequence[sequence]
ur_billing_demand_lookback_period

Billing demand lookback period [mn]

Constraints: INTEGER,MIN=0,MAX=12

Required: Required if ur_enable_billing_demand=1

Type:float
ur_billing_demand_minimum

Minimum billing demand

Required: Required if ur_enable_billing_demand=1

Type:float
ur_dc_billing_demand_periods

Billing demand applicability to a given demand charge time of use period

Required: Required if ur_enable_billing_demand=1

Type:sequence[sequence]
ur_dc_enable

Enable demand charge [0/1]

Constraints: BOOLEAN

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
ur_dc_flat_mat

Demand rates (flat) table

Required: Required if ur_dc_enable=1

Type:sequence[sequence]
ur_dc_sched_weekday

Demand charge weekday schedule

Info: 12x24

Type:sequence[sequence]
ur_dc_sched_weekend

Demand charge weekend schedule

Info: 12x24

Type:sequence[sequence]
ur_dc_tou_mat

Demand rates (TOU) table

Required: Required if ur_dc_enable=1

Type:sequence[sequence]
ur_ec_sched_weekday

Energy charge weekday schedule

Info: 12x24

Type:sequence[sequence]
ur_ec_sched_weekend

Energy charge weekend schedule

Info: 12x24

Type:sequence[sequence]
ur_ec_tou_mat

Energy rates table

Type:sequence[sequence]
ur_en_ts_buy_rate

Enable time step buy rates [0/1]

Constraints: BOOLEAN

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
ur_en_ts_sell_rate

Enable time step sell rates [0/1]

Constraints: BOOLEAN

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
ur_enable_billing_demand

Enable billing demand ratchets [0/1]

Options: 0=disable,1=enable

Constraints: INTEGER,MIN=0,MAX=1

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
ur_metering_option

Metering options [0=net energy metering,1=net energy metering with $ credits,2=net billing,3=net billing with carryover to next month,4=buy all - sell all]

Info: Net metering monthly excess

Constraints: INTEGER,MIN=0,MAX=4

Required: False. Automatically set to 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_monthly_min_charge

Monthly minimum charge [$]

Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.

Type:float
ur_nm_credit_month

Month of year end payout (true-up) [mn]

Constraints: INTEGER,MIN=0,MAX=11

Required: False. Automatically set to 11 if not assigned explicitly or loaded from defaults.

Type:float
ur_nm_credit_rollover

Apply net metering true-up credits to future bills [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
ur_nm_yearend_sell_rate

Net metering true-up credit sell rate [$/kWh]

Required: False. Automatically set to 0.0 if not assigned explicitly or loaded from defaults.

Type:float
ur_sell_eq_buy

Set sell rate equal to buy rate [0/1]

Info: Optional override

Constraints: BOOLEAN

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:float
ur_ts_buy_rate

Time step buy rates [0/1]

Type:sequence
ur_ts_sell_rate

Time step sell rates [0/1]

Type:sequence
ur_yearzero_usage_peaks

Peak usage by month for year zero

Info: 12

Required: Required if ur_enable_billing_demand=1

Type:sequence

GridLimits Group

class PySAM.Pvsamv1.Pvsamv1.GridLimits
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

GridLimits_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

GridLimits_vals = { var: val, ...}

enable_interconnection_limit

Enable grid interconnection limit [0/1]

Info: Enable a grid interconnection limit

Type:float
grid_curtailment

Grid curtailment as energy delivery limit (first year) [MW]

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
grid_interconnection_limit_kwac

Grid interconnection limit [kWac]

Type:float

AdjustmentFactors Group

class PySAM.Pvsamv1.Pvsamv1.AdjustmentFactors
assign() → None

Assign attributes from dictionary

export() → Dict

Export attributes into dictionary

constant

float

Type:type
dc_constant

DC Constant loss adjustment [%]

dc_hourly

DC Hourly Adjustment Factors [%]

dc_periods

DC Period-based Adjustment Factors [%]

hourly

AC Hourly Adjustment Factors [%]

periods

AC Period-based Adjustment Factors [%]

sf_constant

DC Constant loss adjustment [%]

sf_hourly

DC Hourly Adjustment Factors [%]

sf_periods

DC Period-based Adjustment Factors [%]

Outputs Group

class PySAM.Pvsamv1.Pvsamv1.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, ...}

ac_gross

Inverter AC output power [kW]

Type:sequence
ac_lifetime_loss

AC lifetime daily loss [kW]

Type:sequence
ac_perf_adj_loss

AC performance adjustment loss [kW]

Type:sequence
ac_transmission_loss

Transmission loss [kW]

Type:sequence
ac_wiring_loss

AC wiring loss [kW]

Type:sequence
airmass

Absolute air mass

Type:sequence
alb

Albedo

Type:sequence
annual_ac_battery_loss_percent

AC-connected battery loss - year 1 [%]

Type:float
annual_ac_gross

Annual AC energy gross [kWh/yr]

Type:float
annual_ac_inv_clip_loss_percent

AC inverter power clipping loss [%]

Type:float
annual_ac_inv_eff_loss_percent

AC inverter efficiency loss [%]

Type:float
annual_ac_inv_pnt_loss_percent

AC inverter night tare loss [%]

Type:float
annual_ac_inv_pso_loss_percent

AC inverter power consumption loss [%]

Type:float
annual_ac_lifetime_loss_percent

AC lifetime daily loss - year 1 [%]

Type:float
annual_ac_loss_ond

Annual AC loss OND model [kWh/yr]

Type:float
annual_ac_perf_adj_loss_percent

AC performance adjustment loss [%]

Type:float
annual_ac_wiring_loss

AC wiring loss [kWh]

Type:float
annual_ac_wiring_loss_percent

AC wiring loss [%]

Type:float
annual_crit_load

Critical load energy (year 1) [kWh]

Type:float
annual_crit_load_unmet

Critical load energy unmet (year 1) [kWh]

Type:float
annual_crit_load_unmet_percentage

Critical load unmet percentage (year 1) [%]

Type:float
annual_dc_battery_loss_percent

DC connected battery loss- year 1 [%]

Type:float
annual_dc_diodes_loss

DC diodes and connections loss [kWh]

Type:float
annual_dc_diodes_loss_percent

DC diodes and connections loss [%]

Type:float
annual_dc_gross

Annual DC energy gross [kWh/yr]

Type:float
annual_dc_inv_tdc_loss_percent

DC inverter thermal derate loss [%]

Type:float
annual_dc_invmppt_loss

Inverter clipping loss DC MPPT voltage limits [kWh/yr]

Type:float
annual_dc_lifetime_loss_percent

Lifetime daily DC loss- year 1 [%]

Type:float
annual_dc_loss_ond

Annual DC loss OND model [kWh/yr]

Type:float
annual_dc_mismatch_loss

DC mismatch loss [kWh]

Type:float
annual_dc_mismatch_loss_percent

DC mismatch loss [%]

Type:float
annual_dc_module_loss_percent

DC module deviation from STC [%]

Type:float
annual_dc_mppt_clip_loss_percent

DC inverter MPPT clipping loss [%]

Type:float
annual_dc_nameplate_loss

DC nameplate loss [kWh]

Type:float
annual_dc_nameplate_loss_percent

DC nameplate loss [%]

Type:float
annual_dc_net

Annual DC energy [kWh/yr]

Type:float
annual_dc_nominal

Annual DC energy nominal [kWh/yr]

Type:float
annual_dc_optimizer_loss

DC power optimizer loss [kWh]

Type:float
annual_dc_optimizer_loss_percent

DC power optimizer loss [%]

Type:float
annual_dc_perf_adj_loss_percent

DC performance adjustment loss [%]

Type:float
annual_dc_snow_loss_percent

DC snow loss [%]

Type:float
annual_dc_tracking_loss

DC tracking loss [kWh]

Type:float
annual_dc_tracking_loss_percent

DC tracking loss [%]

Type:float
annual_dc_wiring_loss

DC wiring loss [kWh]

Type:float
annual_dc_wiring_loss_percent

DC wiring loss [%]

Type:float
annual_energy

Annual AC energy [kWh]

Type:float
annual_energy_distribution_time

Annual energy production as function of time [kW]

Type:sequence[sequence]
annual_export_to_grid_energy

Annual energy exported to grid [kWh]

Type:sequence
annual_gh

Annual GHI [Wh/m2/yr]

Type:float
annual_import_to_grid_energy

Annual energy imported from grid [kWh]

Type:sequence
annual_inv_cliploss

Inverter clipping loss AC power limit [kWh/yr]

Type:float
annual_inv_pntloss

Inverter night time loss [kWh/yr]

Type:float
annual_inv_psoloss

Inverter power consumption loss [kWh/yr]

Type:float
annual_inv_tdcloss

Inverter thermal derate DC power loss [kWh/yr]

Type:float
annual_outage_losses_unmet

Battery and system losses unmet energy (year 1) [kWh]

Type:float
annual_poa_beam_eff

POA front-side irradiance beam after shading and soiling [kWh/yr]

Type:float
annual_poa_beam_nom

POA front-side irradiance beam nominal [kWh/yr]

Type:float
annual_poa_cover_loss_percent

POA front-side reflection (IAM) loss [%]

Type:float
annual_poa_eff

POA irradiance total after reflection (IAM) [kWh/yr]

Type:float
annual_poa_front

POA front-side irradiance total after reflection (IAM) [kWh/yr]

Type:float
annual_poa_nom

POA front-side irradiance total nominal [kWh/yr]

Type:float
annual_poa_rear

POA rear-side irradiance total after reflection (IAM) [kWh/yr]

Type:float
annual_poa_rear_gain_percent

POA rear-side bifacial gain [%]

Type:float
annual_poa_shaded

POA front-side irradiance total after shading [kWh/yr]

Type:float
annual_poa_shaded_soiled

POA front-side irradiance total after shading and soiling [kWh/yr]

Type:float
annual_poa_shading_loss_percent

POA front-side shading loss [%]

Type:float
annual_poa_soiling_loss_percent

POA front-side soiling loss [%]

Type:float
annual_snow_loss

Snow DC energy loss [kWh/yr]

Type:float
annual_subarray1_dc_diodes_loss

Subarray 1 DC diodes and connections loss [kWh]

Type:float
annual_subarray1_dc_gross

Subarray 1 Gross DC energy [kWh]

Type:float
annual_subarray1_dc_mismatch_loss

Subarray 1 DC mismatch loss [kWh]

Type:float
annual_subarray1_dc_nameplate_loss

Subarray 1 DC nameplate loss [kWh]

Type:float
annual_subarray1_dc_tracking_loss

Subarray 1 DC tracking loss [kWh]

Type:float
annual_subarray1_dc_wiring_loss

Subarray 1 DC wiring loss [kWh]

Type:float
annual_subarray2_dc_diodes_loss

Subarray 2 DC diodes and connections loss [kWh]

Type:float
annual_subarray2_dc_gross

Subarray 2 Gross DC energy [kWh]

Type:float
annual_subarray2_dc_mismatch_loss

Subarray 2 DC mismatch loss [kWh]

Type:float
annual_subarray2_dc_nameplate_loss

Subarray 2 DC nameplate loss [kWh]

Type:float
annual_subarray2_dc_tracking_loss

Subarray 2 DC tracking loss [kWh]

Type:float
annual_subarray2_dc_wiring_loss

Subarray 2 DC wiring loss [kWh]

Type:float
annual_subarray3_dc_diodes_loss

Subarray 3 DC diodes and connections loss [kWh]

Type:float
annual_subarray3_dc_gross

Subarray 3 Gross DC energy [kWh]

Type:float
annual_subarray3_dc_mismatch_loss

Subarray 3 DC mismatch loss [kWh]

Type:float
annual_subarray3_dc_nameplate_loss

Subarray 3 DC nameplate loss [kWh]

Type:float
annual_subarray3_dc_tracking_loss

Subarray 3 DC tracking loss [kWh]

Type:float
annual_subarray3_dc_wiring_loss

Subarray 3 DC wiring loss [kWh]

Type:float
annual_subarray4_dc_diodes_loss

Subarray 4 DC diodes and connections loss [kWh]

Type:float
annual_subarray4_dc_gross

Subarray 4 Gross DC energy [kWh]

Type:float
annual_subarray4_dc_mismatch_loss

Subarray 4 DC mismatch loss [kWh]

Type:float
annual_subarray4_dc_nameplate_loss

Subarray 4 DC nameplate loss [kWh]

Type:float
annual_subarray4_dc_tracking_loss

Subarray 4 DC tracking loss [kWh]

Type:float
annual_subarray4_dc_wiring_loss

Subarray 4 DC wiring loss [kWh]

Type:float
annual_total_loss_percent

Total loss from nominal POA to net AC [kWh]

Type:float
annual_transmission_loss

Transmission loss [kWh]

Type:float
annual_transmission_loss_percent

AC transmission loss [%]

Type:float
annual_xfmr_loss_percent

Transformer loss percent [%]

Type:float
average_battery_conversion_efficiency

Battery average cycle conversion efficiency [%]

Type:float
average_battery_roundtrip_efficiency

Battery average roundtrip efficiency [%]

Type:float
avg_critical_load

Hours of autonomy during grid outage critical load met [kWh]

Type:float
batt_DOD

Battery cycle depth of discharge [%]

Type:sequence
batt_DOD_cycle_average

Battery average cycle DOD

Type:sequence
batt_I

Battery current [A]

Type:sequence
batt_SOC

Battery state of charge [%]

Type:sequence
batt_annual_charge_energy

Battery annual energy charged [kWh]

Type:sequence
batt_annual_charge_from_grid

Battery annual energy charged from grid [kWh]

Type:sequence
batt_annual_charge_from_system

Battery annual energy charged from system [kWh]

Type:sequence
batt_annual_discharge_energy

Battery annual energy discharged [kWh]

Type:sequence
batt_annual_energy_loss

Battery annual energy loss [kWh]

Type:sequence
batt_annual_energy_system_loss

Battery annual system energy loss [kWh]

Type:sequence
batt_bank_installed_capacity

Battery bank installed capacity [kWh]

Type:float
batt_bank_replacement

Battery bank replacements per year [number/year]

Type:sequence
batt_capacity_percent

Battery relative capacity to nameplate [%]

Type:sequence
batt_capacity_percent_calendar

Battery relative capacity to nameplate (calendar) [%]

Type:sequence
batt_capacity_percent_cycle

Battery relative capacity to nameplate (cycling) [%]

Type:sequence
batt_capacity_thermal_percent

Battery capacity percent for temperature [%]

Type:sequence
batt_conversion_loss

Battery loss from power electronics [kW]

Type:sequence
batt_cost_to_cycle

Battery computed cycle degradation penalty [$/cycle-kWh]

Type:sequence
batt_cycles

Battery number of cycles

Type:sequence
batt_dispatch_sched

Battery dispatch schedule

Type:sequence[sequence]
batt_power

Electricity to/from battery [kW]

Type:sequence
batt_power_target

Electricity battery power target for automated dispatch [kW]

Type:sequence
batt_pvs_PV_ramp_interval

PV smoothing PV power sampled [kW]

Type:sequence
batt_pvs_P_pv_ac

PV smoothing PV power before smoothing [kW]

Type:sequence
batt_pvs_battpower

PV smoothing battpower [kW]

Type:sequence
batt_pvs_battsoc

PV smoothing battery SOC [%]

Type:sequence
batt_pvs_curtail

PV smoothing curtailed power [kW]

Type:sequence
batt_pvs_energy_to_grid_percent

PV smoothing energy to grid percent (loss due to curtail and battery loss) [%]

Type:float
batt_pvs_energy_to_grid_percent_sam

PV smoothing energy to grid percent actual (loss due to curtail and battery loss) [%]

Type:float
batt_pvs_forecast_pv_energy

PV smoothing PV power forecast [kW]

Type:sequence
batt_pvs_outpower

PV smoothing outpower [kW]

Type:sequence
batt_pvs_violation_count

PV smoothing violation count

Type:float
batt_pvs_violation_list

PV smoothing violation

Type:sequence
batt_pvs_violation_percent

PV smoothing violation percent (of all intervals-including nighttime) [%]

Type:float
batt_q0

Battery total charge [Ah]

Type:sequence
batt_q1

Battery available charge [Ah]

Type:sequence
batt_q2

Battery bound charge [Ah]

Type:sequence
batt_qmax

Battery maximum charge with degradation [Ah]

Type:sequence
batt_qmaxI

Battery maximum capacity at current [Ah]

Type:sequence
batt_qmax_thermal

Battery maximum charge at temperature [Ah]

Type:sequence
batt_revenue_charge

Revenue to charge from system [$/kWh]

Type:sequence
batt_revenue_clipcharge

Revenue to charge from clipped [$/kWh]

Type:sequence
batt_revenue_discharge

Revenue to discharge [$/kWh]

Type:sequence
batt_revenue_gridcharge

Revenue to charge from grid [$/kWh]

Type:sequence
batt_system_charge_percent

Battery charge energy charged from system [%]

Type:float
batt_system_loss

Battery loss from ancillary equipment [kW]

Type:sequence
batt_temperature

Battery temperature [C]

Type:sequence
batt_to_grid

Electricity to grid from battery [kW]

Type:sequence
batt_to_load

Electricity to load from battery [kW]

Type:sequence
batt_to_system_load

Electricity to system loads from battery [kW]

Type:sequence
batt_voltage

Battery voltage [V]

Type:sequence
batt_voltage_cell

Battery cell voltage [V]

Type:sequence
capacity_factor

Capacity factor based on nameplate DC capacity [%]

Type:float
capacity_factor_ac

Capacity factor based on total AC capacity [%]

Type:float
cdf_of_surviving

Hours of autonomy during grid outage cumulative probabilities

Type:sequence
crit_load

Critical load in this timestep [kW]

Type:sequence
crit_load_unmet

Critical load unmet in this timestep [kW]

Type:sequence
dc_degrade_factor

Annual DC degradation factor

Type:sequence
dc_invmppt_loss

Inverter clipping loss DC MPPT voltage limits [kW]

Type:sequence
dc_lifetime_loss

DC lifetime daily loss [kW]

Type:sequence
dc_net

Inverter DC input power [kW]

Type:sequence
dc_snow_loss

DC power loss due to snow [kW]

Type:sequence
df

Irradiance DHI from weather file [W/m2]

Type:sequence
df_calc

Irradiance DHI calculated [W/m2]

Type:sequence
dn

Irradiance DNI from weather file [W/m2]

Type:sequence
dn_calc

Irradiance DNI calculated [W/m2]

Type:sequence
fuelcell_to_batt

Electricity to battery from fuel cell [kW]

Type:sequence
gen

System power generated [kW]

Type:sequence
gen_without_battery

Power produced without the battery or curtailment [kW]

Type:sequence
gh

Irradiance GHI from weather file [W/m2]

Type:sequence
gh_calc

Irradiance GHI calculated [W/m2]

Type:sequence
grid_power

Electricity to/from grid [kW]

Type:sequence
grid_power_target

Electricity grid power target for automated dispatch [kW]

Type:sequence
grid_to_batt

Electricity to battery from grid [kW]

Type:sequence
grid_to_load

Electricity to load from grid [kW]

Type:sequence
interconnection_loss

Electricity loss due to curtailment, interconnection, or outage [kW]

Type:sequence
inv_cliploss

Inverter clipping loss AC power limit [kW]

Type:sequence
inv_eff

Inverter efficiency [%]

Type:sequence
inv_pntloss

Inverter night time loss [kW]

Type:sequence
inv_psoloss

Inverter power consumption loss [kW]

Type:sequence
inv_tdcloss

Inverter thermal derate DC power loss [kW]

Type:sequence
inv_total_loss

Inverter total power loss [kW]

Type:sequence
inverterMPPT1_DCVoltage

Inverter MPPT 1 Nominal DC voltage [V]

Type:sequence
inverterMPPT2_DCVoltage

Inverter MPPT 2 Nominal DC voltage [V]

Type:sequence
inverterMPPT3_DCVoltage

Inverter MPPT 3 Nominal DC voltage [V]

Type:sequence
inverterMPPT4_DCVoltage

Inverter MPPT 4 Nominal DC voltage [V]

Type:sequence
kwh_per_kw

Energy yield [kWh/kW]

Type:float
market_sell_rate_series_yr1

Power price for battery dispatch [$/MWh]

Type:sequence
monthly_batt_to_grid

Energy to grid from battery [kWh]

Type:sequence
monthly_batt_to_load

Energy to load from battery [kWh]

Type:sequence
monthly_batt_to_system_load

Energy to system loads from battery [kWh]

Type:sequence
monthly_crit_load

Critical load energy [kWh]

Type:sequence
monthly_crit_load_unmet

Critical load energy unmet [kWh]

Type:sequence
monthly_crit_load_unmet_percentage

Critical load unmet percentage [%]

Type:sequence
monthly_dc

DC energy [kWh/mo]

Type:sequence
monthly_energy

AC energy [kWh/mo]

Type:sequence
monthly_grid_to_batt

Energy to battery from grid [kWh]

Type:sequence
monthly_grid_to_load

Energy to load from grid [kWh]

Type:sequence
monthly_interconnection_loss

Energy loss due to curtailment, interconnection, or outage [kWh]

Type:sequence
monthly_outage_losses_unmet

Battery and system losses unmet energy [kWh]

Type:sequence
monthly_poa_beam_eff

POA front-side irradiance beam after shading and soiling [kWh/mo]

Type:sequence
monthly_poa_beam_nom

POA front-side irradiance beam nominal [kWh/mo]

Type:sequence
monthly_poa_eff

POA irradiance total after shading and soiling [kWh/mo]

Type:sequence
monthly_poa_front

POA front-side irradiance total [kWh/mo]

Type:sequence
monthly_poa_nom

POA front-side irradiance total nominal [kWh/mo]

Type:sequence
monthly_poa_rear

POA rear-side irradiance total [kWh/mo]

Type:sequence
monthly_snow_loss

Snow DC energy loss [kWh/mo]

Type:sequence
monthly_system_to_batt

Energy to battery from system [kWh]

Type:sequence
monthly_system_to_grid

Energy to grid from system [kWh]

Type:sequence
monthly_system_to_load

Energy to load from system [kWh]

Type:sequence
nameplate_dc_rating

System nameplate DC rating [kW]

Type:float
outage_durations

Hours of autonomy during grid outage hour list from min to max [hr]

Type:sequence
outage_losses_unmet

Battery and system losses unmet in this timestep [kW]

Type:sequence
pdf_of_surviving

Hours of autonomy during grid outage probabilities

Type:sequence
performance_ratio

Performance ratio

Type:float
poa_beam_eff

Array POA beam radiation after shading and soiling [kW]

Type:sequence
poa_beam_nom

Array POA front-side beam radiation nominal [kW]

Type:sequence
poa_eff

Array POA radiation total after reflection (IAM) [kW]

Type:sequence
poa_front

Array POA front-side total radiation after reflection (IAM) [kW]

Type:sequence
poa_nom

Array POA front-side total radiation nominal [kW]

Type:sequence
poa_rear

Array POA rear-side total radiation after reflection (IAM) [kW]

Type:sequence
poa_shaded

Array POA front-side total radiation after shading only [kW]

Type:sequence
poa_shaded_soiled

Array POA front-side total radiation after shading and soiling [kW]

Type:sequence
resilience_hrs

Hours of autonomy during grid outage at each timestep [hr]

Type:sequence
resilience_hrs_avg

Hours of autonomy during grid outage average [hr]

Type:float
resilience_hrs_max

Hours of autonomy during grid outage maximum [hr]

Type:float
resilience_hrs_min

Hours of autonomy during grid outage minimum [hr]

Type:float
shadedb_subarray1_shade_frac

Subarray 1 Partial external shading DC factor [frac]

Type:sequence
shadedb_subarray2_shade_frac

Subarray 2 Partial shading DC factor [frac]

Type:sequence
shadedb_subarray3_shade_frac

Subarray 3 Partial external shading DC factor [frac]

Type:sequence
shadedb_subarray4_shade_frac

Subarray 4 Partial external shading DC factor [frac]

Type:sequence
sixpar_Adj

Adj

Type:float
Type:CEC 6-parameter
sixpar_Il

Il

Type:float
Type:CEC 6-parameter
sixpar_Io

Io

Type:float
Type:CEC 6-parameter
sixpar_Rs

Rs

Type:float
Type:CEC 6-parameter
sixpar_Rsh

Rsh

Type:float
Type:CEC 6-parameter
sixpar_a

a

Type:float
Type:CEC 6-parameter
snowdepth

Weather file snow depth [cm]

Type:sequence
sol_alt

Sun altitude angle [deg]

Type:sequence
sol_azi

Sun azimuth angle [deg]

Type:sequence
sol_zen

Sun zenith angle [deg]

Type:sequence
subarray1_aoi

Subarray 1 Angle of incidence [deg]

Type:sequence
subarray1_aoi_modifier

Subarray 1 Angle of incidence Modifier [0-1]

Type:sequence
subarray1_axisrot

Subarray 1 Axis rotation for 1 axis trackers [deg]

Type:sequence
subarray1_beam_shading_factor

Subarray 1 External shading and soiling beam irradiance factor [frac]

Type:sequence
subarray1_celltemp

Subarray 1 Cell temperature [C]

Type:sequence
subarray1_celltempSS

Subarray 1 Cell temperature (steady state) [C]

Type:sequence
subarray1_dc_gross

Subarray 1 DC power gross [kW]

Type:sequence
subarray1_dc_voltage

Subarray 1 Operating DC voltage [V]

Type:sequence
subarray1_dcloss

Subarray 1 Total DC power loss [%]

Type:float
subarray1_idealrot

Subarray 1 Axis rotation ideal for 1 axis trackers [deg]

Type:sequence
subarray1_isc

Subarray 1 String short circuit DC current [A]

Type:sequence
subarray1_linear_derate

Subarray 1 Self-shading linear beam irradiance factor [frac]

Type:sequence
subarray1_modeff

Subarray 1 Module efficiency [%]

Type:sequence
subarray1_poa_eff

Subarray 1 POA total irradiance after reflection (IAM) [W/m2]

Type:sequence
subarray1_poa_eff_beam

Subarray 1 POA front beam irradiance after shading and soiling [W/m2]

Type:sequence
subarray1_poa_eff_diff

Subarray 1 POA front diffuse irradiance after shading and soiling [W/m2]

Type:sequence
subarray1_poa_front

Subarray 1 POA front total irradiance after reflection (IAM) [W/m2]

Type:sequence
subarray1_poa_nom

Subarray 1 POA front total irradiance nominal [W/m2]

Type:sequence
subarray1_poa_rear

Subarray 1 POA rear total irradiance after reflection (IAM) [W/m2]

Type:sequence
subarray1_poa_shaded

Subarray 1 POA front total irradiance after shading only [W/m2]

Type:sequence
subarray1_poa_shaded_soiled

Subarray 1 POA front total irradiance after shading and soiling [W/m2]

Type:sequence
subarray1_snow_coverage

Subarray 1 Snow cover [0..1]

Type:sequence
subarray1_snow_loss

Subarray 1 Snow cover DC power loss [kW]

Type:sequence
subarray1_soiling_derate

Subarray 1 Soiling beam irradiance factor [frac]

Type:sequence
subarray1_ss_derate

Subarray 1 Self-shading non-linear DC factor [frac]

Type:sequence
subarray1_ss_diffuse_derate

Subarray 1 Self-shading non-linear sky diffuse irradiance factor [frac]

Type:sequence
subarray1_ss_reflected_derate

Subarray 1 Self-shading non-linear ground diffuse irradiance factor [frac]

Type:sequence
subarray1_surf_azi

Subarray 1 Surface azimuth [deg]

Type:sequence
subarray1_surf_tilt

Subarray 1 Surface tilt [deg]

Type:sequence
subarray1_voc

Subarray 1 Open circuit DC voltage [V]

Type:sequence
subarray2_aoi

Subarray 2 Angle of incidence [deg]

Type:sequence
subarray2_aoi_modifier

Subarray 2 Angle of incidence Modifier [0-1]

Type:sequence
subarray2_axisrot

Subarray 2 Axis rotation for 1 axis trackers [deg]

Type:sequence
subarray2_beam_shading_factor

Subarray 2 External shading and soiling beam irradiance factor [frac]

Type:sequence
subarray2_celltemp

Subarray 2 Cell temperature [C]

Type:sequence
subarray2_celltempSS

Subarray 2 Cell temperature (steady state) [C]

Type:sequence
subarray2_dc_gross

Subarray 2 DC power gross [kW]

Type:sequence
subarray2_dc_voltage

Subarray 2 Operating DC voltage [V]

Type:sequence
subarray2_dcloss

Subarray 2 Total DC power loss [%]

Type:float
subarray2_idealrot

Subarray 2 Axis rotation ideal for 1 axis trackers [deg]

Type:sequence
subarray2_isc

Subarray 2 String short circuit DC current [A]

Type:sequence
subarray2_linear_derate

Subarray 2 Self-shading linear beam irradiance factor [frac]

Type:sequence
subarray2_modeff

Subarray 2 Module efficiency [%]

Type:sequence
subarray2_poa_eff

Subarray 2 POA total irradiance after module reflection (IAM) [W/m2]

Type:sequence
subarray2_poa_eff_beam

Subarray 2 POA front beam irradiance after shading and soiling [W/m2]

Type:sequence
subarray2_poa_eff_diff

Subarray 2 POA front diffuse irradiance after shading and soiling [W/m2]

Type:sequence
subarray2_poa_front

Subarray 2 POA front total irradiance after reflection (IAM) [W/m2]

Type:sequence
subarray2_poa_nom

Subarray 2 POA front total irradiance nominal [W/m2]

Type:sequence
subarray2_poa_rear

Subarray 2 POA rear irradiance after reflection (IAM) [W/m2]

Type:sequence
subarray2_poa_shaded

Subarray 2 POA front total irradiance after shading only [W/m2]

Type:sequence
subarray2_poa_shaded_soiled

Subarray 2 POA front total irradiance after shading and soiling [W/m2]

Type:sequence
subarray2_snow_coverage

Subarray 2 Snow cover [0..1]

Type:sequence
subarray2_snow_loss

Subarray 2 Snow cover DC power loss [kW]

Type:sequence
subarray2_soiling_derate

Subarray 2 Soiling beam irradiance factor [frac]

Type:sequence
subarray2_ss_derate

Subarray 2 Self-shading non-linear DC factor [frac]

Type:sequence
subarray2_ss_diffuse_derate

Subarray 2 Self-shading non-linear sky diffuse irradiance factor [frac]

Type:sequence
subarray2_ss_reflected_derate

Subarray 2 Self-shading non-linear ground diffuse irradiance factor [frac]

Type:sequence
subarray2_surf_azi

Subarray 2 Surface azimuth [deg]

Type:sequence
subarray2_surf_tilt

Subarray 2 Surface tilt [deg]

Type:sequence
subarray2_voc

Subarray 2 Open circuit DC voltage [V]

Type:sequence
subarray3_aoi

Subarray 3 Angle of incidence [deg]

Type:sequence
subarray3_aoi_modifier

Subarray 3 Angle of incidence Modifier [0-1]

Type:sequence
subarray3_axisrot

Subarray 3 Axis rotation for 1 axis trackers [deg]

Type:sequence
subarray3_beam_shading_factor

Subarray 3 External shading and soiling beam irradiance factor [frac]

Type:sequence
subarray3_celltemp

Subarray 3 Cell temperature [C]

Type:sequence
subarray3_celltempSS

Subarray 3 Cell temperature (steady state) [C]

Type:sequence
subarray3_dc_gross

Subarray 3 DC power gross [kW]

Type:sequence
subarray3_dc_voltage

Subarray 3 Operating DC voltage [V]

Type:sequence
subarray3_dcloss

Subarray 3 Total DC power loss [%]

Type:float
subarray3_idealrot

Subarray 3 Axis rotation ideal for 1 axis trackers [deg]

Type:sequence
subarray3_isc

Subarray 3 String short circuit DC current [A]

Type:sequence
subarray3_linear_derate

Subarray 3 Self-shading linear beam irradiance factor [frac]

Type:sequence
subarray3_modeff

Subarray 3 Module efficiency [%]

Type:sequence
subarray3_poa_eff

Subarray 3 POA total irradiance after reflection (IAM) [W/m2]

Type:sequence
subarray3_poa_eff_beam

Subarray 3 POA front beam irradiance after shading and soiling [W/m2]

Type:sequence
subarray3_poa_eff_diff

Subarray 3 POA front diffuse irradiance after shading and soiling [W/m2]

Type:sequence
subarray3_poa_front

Subarray 3 POA front total irradiance after reflection (IAM) [W/m2]

Type:sequence
subarray3_poa_nom

Subarray 3 POA font total irradiance nominal [W/m2]

Type:sequence
subarray3_poa_rear

Subarray 3 POA rear irradiance after reflection (IAM) [W/m2]

Type:sequence
subarray3_poa_shaded

Subarray 3 POA front total irradiance after shading only [W/m2]

Type:sequence
subarray3_poa_shaded_soiled

Subarray 3 POA front total irradiance after shading and soiling [W/m2]

Type:sequence
subarray3_snow_coverage

Subarray 3 Snow cover [0..1]

Type:sequence
subarray3_snow_loss

Subarray 3 Snow cover DC power loss [kW]

Type:sequence
subarray3_soiling_derate

Subarray 3 Soiling beam irradiance factor [frac]

Type:sequence
subarray3_ss_derate

Subarray 3 Self-shading non-linear DC factor [frac]

Type:sequence
subarray3_ss_diffuse_derate

Subarray 3 Self-shading non-linear sky diffuse irradiance factor [frac]

Type:sequence
subarray3_ss_reflected_derate

Subarray 3 Self-shading non-linear ground diffuse irradiance factor [frac]

Type:sequence
subarray3_surf_azi

Subarray 3 Surface azimuth [deg]

Type:sequence
subarray3_surf_tilt

Subarray 3 Surface tilt [deg]

Type:sequence
subarray3_voc

Subarray 3 Open circuit DC voltage [V]

Type:sequence
subarray4_aoi

Subarray 4 Angle of incidence [deg]

Type:sequence
subarray4_aoi_modifier

Subarray 4 Angle of incidence Modifier [0-1]

Type:sequence
subarray4_axisrot

Subarray 4 Axis rotation for 1 axis trackers [deg]

Type:sequence
subarray4_beam_shading_factor

Subarray 4 External shading and soiling beam irradiance factor [frac]

Type:sequence
subarray4_celltemp

Subarray 4 Cell temperature [C]

Type:sequence
subarray4_celltempSS

Subarray 4 Cell temperature (steady state) [C]

Type:sequence
subarray4_dc_gross

Subarray 4 DC power gross [kW]

Type:sequence
subarray4_dc_voltage

Subarray 4 Operating DC voltage [V]

Type:sequence
subarray4_dcloss

Subarray 4 Total DC power loss [%]

Type:float
subarray4_idealrot

Subarray 4 Axis rotation ideal for 1 axis trackers [deg]

Type:sequence
subarray4_isc

Subarray 4 String short circuit DC current [A]

Type:sequence
subarray4_linear_derate

Subarray 4 Self-shading linear beam irradiance factor [frac]

Type:sequence
subarray4_modeff

Subarray 4 Module efficiency [%]

Type:sequence
subarray4_poa_eff

Subarray 4 POA total irradiance after reflection (IAM) [W/m2]

Type:sequence
subarray4_poa_eff_beam

Subarray 4 POA front beam irradiance after shading and soiling [W/m2]

Type:sequence
subarray4_poa_eff_diff

Subarray 4 POA front diffuse irradiance after shading and soiling [W/m2]

Type:sequence
subarray4_poa_front

Subarray 4 POA front total irradiance after reflection (IAM) [W/m2]

Type:sequence
subarray4_poa_nom

Subarray 4 POA front total irradiance nominal [W/m2]

Type:sequence
subarray4_poa_rear

Subarray 4 POA rear irradiance after reflection (IAM) [W/m2]

Type:sequence
subarray4_poa_shaded

Subarray 4 POA front total irradiance after shading only [W/m2]

Type:sequence
subarray4_poa_shaded_soiled

Subarray 4 POA front total irradiance after shading and soiling [W/m2]

Type:sequence
subarray4_snow_coverage

Subarray 4 Snow cover [0..1]

Type:sequence
subarray4_snow_loss

Subarray 4 Snow cover DC power loss [kW]

Type:sequence
subarray4_soiling_derate

Subarray 4 Soiling beam irradiance factor [frac]

Type:sequence
subarray4_ss_derate

Subarray 4 Self-shading non-linear DC factor [frac]

Type:sequence
subarray4_ss_diffuse_derate

Subarray 4 Self-shading non-linear sky diffuse irradiance factor [frac]

Type:sequence
subarray4_ss_reflected_derate

Subarray 4 Self-shading non-linear ground diffuse irradiance factor [frac]

Type:sequence
subarray4_surf_azi

Subarray 4 Surface azimuth [deg]

Type:sequence
subarray4_surf_tilt

Subarray 4 Surface tilt [deg]

Type:sequence
subarray4_voc

Subarray 4 Open circuit DC voltage [V]

Type:sequence
sunpos_hour

Sun position time [hour]

Type:sequence
sunup

Sun up over horizon [0/1/2/3]

Type:sequence
survival_function

Hours of autonomy during grid outage survival function

Type:sequence
system_to_batt

Electricity to battery from system [kW]

Type:sequence
system_to_grid

Electricity to grid from system [kW]

Type:sequence
system_to_load

Electricity to load from system [kW]

Type:sequence
tdry

Weather file ambient temperature [C]

Type:sequence
ts_shift_hours

Sun position time offset [hours]

Type:float
wfpoa

Irradiance POA from weather file [W/m2]

Type:sequence
wspd

Weather file wind speed [m/s]

Type:sequence
xfmr_ll_ts

Transformer load loss [kW]

Type:sequence
xfmr_ll_year1

Transformer load loss [kWh/yr]

Type:float
xfmr_loss_ts

Transformer total loss [kW]

Type:sequence
xfmr_loss_year1

Transformer total loss [kWh/yr]

Type:float
xfmr_nll_ts

Transformer no load loss [kW]

Type:sequence
xfmr_nll_year1

Transformer no load loss [kWh/yr]

Type:float