Pvwattsv1¶

Pvwattsv1

PySAM.Pvwattsv1.default(config) → Pvwattsv1¶

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.Pvwattsv1.from_existing(data, optional config) → Pvwattsv1¶: Share data with an existing PySAM class. If optional config is a valid configuration name, load the module’s defaults for that configuration.

PySAM.Pvwattsv1.new() → Pvwattsv1¶

PySAM.Pvwattsv1.wrap(ssc_data_t) → Pvwattsv1¶: Load data from a PySSC object.

Warning

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

Pvwattsv1 is a wrapper for the SSC compute module cmod_pvwattsv1.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.Pvwattsv1.Pvwattsv1¶

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 = { 'weather': { 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 = { 'weather': { 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.

Weather Group¶

class PySAM.Pvwattsv1.Pvwattsv1.Weather¶

assign(dict) → None¶

Assign attributes from dictionary, overwriting but not removing values.

Weather_vals = { var: val, ...}

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

replace(dict) → None¶

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

Weather_vals = { var: val, ...}

solar_resource_file¶

local weather file path

Constraints: LOCAL_FILE

Required: True

Type:	str

PVWatts Group¶

class PySAM.Pvwattsv1.Pvwattsv1.PVWatts¶

assign(dict) → None¶

Assign attributes from dictionary, overwriting but not removing values.

PVWatts_vals = { var: val, ...}

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

replace(dict) → None¶

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

PVWatts_vals = { var: val, ...}

albedo¶

Albedo (ground reflectance) [frac]

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

ar_glass¶

Enable anti-reflective glass coating (beta) [0/1]

Constraints: BOOLEAN

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

Type:	float

azimuth¶

Azimuth angle [deg]

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

Constraints: MIN=0,MAX=360

Required: True

Type:	float

concen¶

Concentration ratio

Constraints: MIN=1

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

Type:	float

derate¶

System derate value [frac]

Constraints: MIN=0,MAX=1

Required: True

Type:	float

enable_user_poa¶

Enable user-defined POA irradiance input [0/1]

Constraints: BOOLEAN

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

Type:	float

fd¶

Diffuse fraction [0..1]

Constraints: MIN=0,MAX=1

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

Type:	float

fhconv¶

Convective heat transfer factor

Constraints: MIN=0.1

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

Type:	float

gamma¶

Max power temperature coefficient [%/C]

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

Type:	float

gcr¶

Ground coverage ratio [0..1]

Constraints: MIN=0,MAX=3

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

Type:	float

i_ref¶

Rating condition irradiance [W/m2]

Constraints: POSITIVE

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

Type:	float

inoct¶

Nominal operating cell temperature [C]

Constraints: POSITIVE

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

Type:	float

inv_eff¶

Inverter efficiency at rated power [frac]

Constraints: MIN=0,MAX=1

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

Type:	float

poa_cutin¶

Min reqd irradiance for operation [W/m2]

Constraints: MIN=0

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

Type:	float

rotlim¶

Tracker rotation limit (+/- 1 axis) [deg]

Constraints: MIN=1,MAX=90

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

Type:	float

shade_mode_1x¶

Tracker self-shading mode [0/1/2]

Options: 0=shading,1=backtrack,2=none

Constraints: INTEGER,MIN=0,MAX=2

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

Type:	float

shading_azal¶

Azimuth x altitude beam shading factors

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 factor

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_mxh¶

Month x Hour beam shading factors

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_timestep¶

Time step beam shading factors

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]

system_size¶

Nameplate capacity [kW]

Required: True

Type:	float

tilt¶

Tilt angle [deg]

Options: H=0,V=90

Constraints: MIN=0,MAX=90

Required: naof:tilt_eq_lat

Type:	float

tilt_eq_lat¶

Tilt=latitude override [0/1]

Constraints: BOOLEAN

Required: na:tilt

Type:	float

track_mode¶

Tracking mode [0/1/2/3]

Info: Fixed,1Axis,2Axis,AziAxis

Constraints: MIN=0,MAX=3,INTEGER

Required: True

Type:	float

tref¶

Reference cell temperature [C]

Constraints: POSITIVE

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

Type:	float

u0¶

thermal model coeff U0

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

u1¶

thermal model coeff U0

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

user_poa¶

User-defined POA irradiance [W/m2]

Constraints: LENGTH=8760

Required: Required if enable_user_poa=1

Type:	sequence

w_stow¶

Wind stow speed [m/s]

Constraints: MIN=0

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

Type:	float

Shading Group¶

AdjustmentFactors Group¶

class PySAM.Pvwattsv1.Pvwattsv1.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.Pvwattsv1.Pvwattsv1.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 system output [Wac]

Type:	sequence

ac_annual¶

Annual AC system output [kWhac]

Type:	float

ac_monthly¶

AC system output [kWhac]

Type:	sequence

annual_energy¶

Annual energy [kWh]

Type:	float

annual_energy_distribution_time¶

Annual energy production as function of time [kW]

Type:	sequence[sequence]

city¶

City

Type:	str

dc¶

DC array output [Wdc]

Type:	sequence

dc_monthly¶

DC array output [kWhdc]

Type:	sequence

df¶

Diffuse irradiance [W/m2]

Type:	sequence

dn¶

Beam irradiance [W/m2]

Type:	sequence

elev¶

Site elevation [m]

Type:	float

gen¶

System power generated [kW]

Type:	sequence

gh¶

Global horizontal irradiance [W/m2]

Type:	sequence

lat¶

Latitude [deg]

Type:	float

location¶

Location ID

Type:	str

lon¶

Longitude [deg]

Type:	float

monthly_energy¶

Monthly energy [kWh]

Type:	sequence

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

Type:	sequence

tcell¶

Module temperature [C]

Type:	sequence

tdew¶

Dew point temperature [C]

Type:	sequence

tpoa¶

Transmitted plane of array irradiance [W/m2]

Type:	sequence

tz¶

Time zone [hr]

Type:	float

wspd¶

Wind speed [m/s]

Type:	sequence