Pvwattsv5¶
Wrapper for SAM Simulation Core model: cmod_pvwattsv5.cpp
Creating an Instance¶
There are three methods to create a new instance of a PySAM module. Using default
populates the newclass’ attributes with default values specific to a config
. Each technology-financialconfiguration corresponds to a SAM GUI configuration. Using new
creates an instance with empty attributes. The wrap
function allows compatibility with PySSC, for details, refer to PySSC.
Pvwattsv5 model description
PVWatts photovoltaic system model with simple inputs
-
PySAM.Pvwattsv5.
default
(config) → Pvwattsv5¶ Use financial config-specific default attributes
-
PySAM.Pvwattsv5.
from_existing
(data, optional config) → Pvwattsv5¶ Share underlying data with an existing PySAM class. If config provided, default attributes are loaded otherwise.
-
PySAM.Pvwattsv5.
new
() → Pvwattsv5¶
-
PySAM.Pvwattsv5.
wrap
(ssc_data_t) → Pvwattsv5¶ Use existing PySSC data
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap
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
-
value
(name, optional value) → Union[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
() → None¶ Assign attributes from dictionary
Lifetime_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
analysis_period
¶ Analysis period [years]
Required: True if system_use_lifetime_output=1
Type: float
-
dc_degradation
¶ Annual DC degradation for lifetime simulations [%/year]
Required: True if system_use_lifetime_output=1
Type: sequence
-
system_use_lifetime_output
¶ Run lifetime simulation [0/1]
Required: If not provided, assumed to be 0
Type: float
-
SolarResource Group¶
-
class
PySAM.Pvwattsv5.Pvwattsv5.
SolarResource
¶ -
assign
() → None¶ Assign attributes from dictionary
SolarResource_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
solar_resource_data
¶ Weather data
Info: dn,df,tdry,wspd,lat,lon,tz
Required: False
Type: dict
-
solar_resource_file
¶ Weather file path
Required: False
Type: str
-
SystemDesign Group¶
-
class
PySAM.Pvwattsv5.Pvwattsv5.
SystemDesign
¶ -
assign
() → None¶ Assign attributes from dictionary
SystemDesign_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
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: If not provided, assumed to be 0
Type: float
-
dc_ac_ratio
¶ DC to AC ratio [ratio]
Constraints: POSITIVE
Required: If not provided, assumed to be 1.1
Type: float
-
gcr
¶ Ground coverage ratio [0..1]
Constraints: MIN=0.01,MAX=0.99
Required: If not provided, assumed to be 0.4
Type: float
-
inv_eff
¶ Inverter efficiency at rated power [%]
Constraints: MIN=90,MAX=99.5
Required: If not provided, assumed to be 96
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: If not provided, assumed to be 0
Type: float
-
shading_azal
¶ Azimuth x altitude beam shading loss [%]
Required: False
Type: sequence[sequence]
-
shading_diff
¶ Diffuse shading loss [%]
Required: False
Type: float
-
shading_mxh
¶ Month x Hour beam shading loss [%]
Required: False
Type: sequence[sequence]
-
shading_timestep
¶ Time step beam shading loss [%]
Required: False
Type: sequence[sequence]
-
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
-
AdjustmentFactors Group¶
-
class
PySAM.Pvwattsv5.Pvwattsv5.
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.Pvwattsv5.Pvwattsv5.
Outputs
¶ -
assign
() → None¶ Assign attributes from dictionary
Outputs_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
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
-
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
¶ System power generated [kW]
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 [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 [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
-