Pvwattsv5

PVWatts photovoltaic system model with simple inputs

PySAM.Pvwattsv5.default(config) → Pvwattsv5

Load defaults for the configuration config. Available configurations are:

None

Note

Some inputs do not have default values and may be assigned a value from the variable’s Required attribute. See variable attribute descriptions below.

PySAM.Pvwattsv5.from_existing(data, optional config) → Pvwattsv5: Share data with an existing PySAM class. If optional config is a valid configuration name, load the module’s defaults for that configuration.

PySAM.Pvwattsv5.new() → Pvwattsv5

PySAM.Pvwattsv5.wrap(ssc_data_t) → Pvwattsv5: Load data from a PySSC object.

Warning

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

Pvwattsv5 is a wrapper for the SSC compute module cmod_pvwattsv5.cpp

Interdependent Variables

The variables listed below are interdependent with other variables. If you change the value of one of these variables, you may need to change values of other variables. The SAM user interface manages these interdependent variables, but in PySAM, it is up to you change the value of all interdependent variables so they are consistent. See Interdependent Variables for examples and details.

None

Functions

class PySAM.Pvwattsv5.Pvwattsv5

This class contains all the variable information for running a simulation. Variables are grouped together in the subclasses as properties. If property assignments are the wrong type, an error is thrown.

assign(dict) → None

Assign attributes from nested dictionary, except for Outputs

nested_dict = { 'Lifetime': { var: val, ...}, ...}

execute(int verbosity) → None: Execute simulation with verbosity level 0 (default) or 1

export() → dict: Export attributes into nested dictionary

get_data_ptr() → Pointer: Get ssc_data_t pointer

replace(dict) → None

Replace attributes from nested dictionary, except for Outputs. Unassigns all values in each Group then assigns from the input dict.

nested_dict = { 'Lifetime': { var: val, ...}, ...}

unassign(name) → None: Unassign a value in any of the variable groups.

value(name, optional value) → None | float | dict | sequence | str: Get or set by name a value in any of the variable groups.

Lifetime Group

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

analysis_period

Analysis period [years]

Required: Required if system_use_lifetime_output=1

Type:: float

dc_degradation

Annual DC degradation for lifetime simulations [%/year]

Required: Required if system_use_lifetime_output=1

Type:: sequence

system_use_lifetime_output

Run lifetime simulation [0/1]

INOUT: This variable is both an input and an output to the compute module.

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

Type:: float

SolarResource Group

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

solar_resource_data

Weather data

Info: dn,df,tdry,wspd,lat,lon,tz

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 path

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

SystemDesign Group

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

array_type

Array type [0/1/2/3/4]

Info: Fixed OR,Fixed Roof,1Axis,Backtracked,2Axis

Constraints: MIN=0,MAX=4,INTEGER

Required: True

Type:: float

azimuth

Azimuth angle [deg]

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

Constraints: MIN=0,MAX=360

Required: array_type<4

Type:: float

batt_simple_enable

Enable Battery [0/1]

Constraints: BOOLEAN

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

Type:: float

dc_ac_ratio

DC to AC ratio [ratio]

Constraints: POSITIVE

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

Type:: float

gcr

Ground coverage ratio [0..1]

Constraints: MIN=0.01,MAX=0.99

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

Type:: float

inv_eff

Inverter efficiency at rated power [%]

Constraints: MIN=90,MAX=99.5

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

Type:: float

losses

System losses [%]

Info: Total system losses

Constraints: MIN=-5,MAX=99

Required: True

Type:: float

module_type

Module type [0/1/2]

Info: Standard,Premium,Thin film

Constraints: MIN=0,MAX=2,INTEGER

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

Type:: float

system_capacity

System size (DC nameplate) [kW]

Required: True

Type:: float

tilt

Tilt angle [deg]

Options: H=0,V=90

Constraints: MIN=0,MAX=90

Required: array_type<4

Type:: float

Shading Group

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

shading_azal

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]

shading_diff

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

shading_en_azal

Enable azimuth x altitude beam shading losses [0/1]

Options: 0=false,1=true

Constraints: BOOLEAN

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

Type:: float

shading_en_diff

Enable diffuse shading loss [0/1]

Options: 0=false,1=true

Constraints: BOOLEAN

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

Type:: float

shading_en_mxh

Enable month x Hour beam shading losses [0/1]

Options: 0=false,1=true

Constraints: BOOLEAN

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

Type:: float

shading_en_string_option

Enable shading string option [0/1]

Options: 0=false,1=true

Constraints: BOOLEAN

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

Type:: float

shading_en_timestep

Enable timestep beam shading losses [0/1]

Options: 0=false,1=true

Constraints: BOOLEAN

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

Type:: float

shading_mxh

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]

shading_string_option

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

shading_timestep

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]

AdjustmentFactors Group

class PySAM.Pvwattsv5.Pvwattsv5.AdjustmentFactors

assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

AdjustmentFactors_vals = { var: val, ...}

export() → dict: Export attributes into dictionary.

replace(dict) → None

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

AdjustmentFactors_vals = { var: val, ...}

adjust_constant

Constant loss adjustment [%]

Info: ‘adjust’ and ‘constant’ separated by _ instead of : after SAM 2022.12.21

Constraints: MAX=100

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

Type:: float

adjust_en_periods

Enable period-based adjustment factors [0/1]

Info: ‘adjust’ and ‘en_periods’ separated by _ instead of : after SAM 2022.12.21

Constraints: BOOLEAN

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

Type:: float

adjust_en_timeindex

Enable lifetime adjustment factors [0/1]

Info: ‘adjust’ and ‘en_timeindex’ separated by _ instead of : after SAM 2022.12.21

Constraints: BOOLEAN

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

Type:: float

adjust_periods

Period-based adjustment factors [%]

Info: Syntax: n x 3 matrix [ start, end, loss ]; Version upgrade: ‘adjust’ and ‘periods’ separated by _ instead of : after SAM 2022.12.21

Constraints: COLS=3

Required: Required if adjust_en_periods=1

Type:: sequence[sequence]

adjust_timeindex

Lifetime adjustment factors [%]

Info: ‘adjust’ and ‘timeindex’ separated by _ instead of : after SAM 2022.12.21

Required: Required if adjust_en_timeindex=1

Type:: sequence

Outputs Group

class PySAM.Pvwattsv5.Pvwattsv5.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

AC inverter power [W]

Type:: sequence

ac_annual

Annual AC system output [kWh]

Type:: float

ac_monthly

AC system output [kWh]

Type:: sequence

annual_energy

Annual energy [kWh]

Type:: float

annual_energy_distribution_time

Annual energy production as function of time [kW]

Type:: sequence[sequence]

aoi

Angle of incidence [deg]

Type:: sequence

capacity_factor

Capacity factor [%]

Type:: float

city

City

Type:: str

dc

DC array power [W]

Type:: sequence

dc_monthly

DC array output [kWh]

Type:: sequence

df

Diffuse irradiance [W/m2]

Type:: sequence

dn

Beam irradiance [W/m2]

Type:: sequence

elev

Site elevation [m]

Type:: float

gen

AC system power (lifetime) [kWh]

Type:: sequence

gh

Global horizontal irradiance [W/m2]

Type:: sequence

inverter_count

Inverter count

Type:: float

inverter_efficiency

Inverter efficiency at rated power [%]

Type:: float

kwh_per_kw

Energy yield [kWh/kW]

Type:: float

lat

Latitude [deg]

Type:: float

location

Location ID

Type:: str

lon

Longitude [deg]

Type:: float

monthly_energy

Monthly energy gross [kWh]

Type:: sequence

percent_complete

Estimated percent of total comleted simulation [%]

Type:: float

poa

Plane of array irradiance [W/m2]

Type:: sequence

poa_monthly

Plane of array irradiance [kWh/m2]

Type:: sequence

shad_beam_factor

Shading factor for beam radiation

Type:: sequence

solrad_annual

Daily average solar irradiance [kWh/m2/day]

Type:: float

solrad_monthly

Daily average solar irradiance [kWh/m2/day]

Type:: sequence

state

State

Type:: str

sunup

Sun up over horizon [0/1]

Type:: sequence

tamb

Ambient temperature (dry bulb temperature) [C]

Type:: sequence

tcell

Module temperature [C]

Type:: sequence

tpoa

Transmitted plane of array irradiance [W/m2]

Type:: sequence

ts_shift_hours

Time offset for interpreting time series outputs [hours]

Type:: float

tz

Time zone [hr]

Type:: float

wspd

Wind speed [m/s]

Type:: sequence