Pvwattsv5Lifetime¶

Wrapper for SAM Simulation Core model: cmod_pvwattsv5_lifetime.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.

Pvwattsv5Lifetime model description

PVWatts photovoltaic system model for multi-year lifetime analysis

PySAM.Pvwattsv5Lifetime.default(config) → Pvwattsv5Lifetime¶

Use financial model-specific default attributes config options:

“FuelCellCommercial”
“FuelCellSingleOwner”

PySAM.Pvwattsv5Lifetime.new() → Pvwattsv5Lifetime¶

PySAM.Pvwattsv5Lifetime.wrap(ssc_data_t) → Pvwattsv5Lifetime¶: Use existing PySSC data

Warning

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

Functions¶

class PySAM.Pvwattsv5Lifetime.Pvwattsv5Lifetime¶

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

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

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

Common Group¶

class PySAM.Pvwattsv5Lifetime.Pvwattsv5Lifetime.Common¶

assign() → None¶

Assign attributes from dictionary

Common_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

system_use_lifetime_output¶

float: Run lifetime simulation [0/1]

Required: True

FinancialAnalysisParameters Group¶

class PySAM.Pvwattsv5Lifetime.Pvwattsv5Lifetime.FinancialAnalysisParameters¶

assign() → None¶

Assign attributes from dictionary

FinancialAnalysisParameters_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

analysis_period¶

float: Analysis period [years]

Required: set to 1 if not provided.

LifetimePV Group¶

class PySAM.Pvwattsv5Lifetime.Pvwattsv5Lifetime.LifetimePV¶

assign() → None¶

Assign attributes from dictionary

LifetimePV_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

dc_degradation¶

sequence: Annual AC degradation [%/year]

Required: set to 1 if not provided.

Weather Group¶

class PySAM.Pvwattsv5Lifetime.Pvwattsv5Lifetime.Weather¶

assign() → None¶

Assign attributes from dictionary

Weather_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

solar_resource_data¶

dict: Weather data

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

Required: False

solar_resource_file¶

str: Weather file path

Required: False

PVWatts Group¶

class PySAM.Pvwattsv5Lifetime.Pvwattsv5Lifetime.PVWatts¶

assign() → None¶

Assign attributes from dictionary

PVWatts_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

array_type¶

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

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

Constraints: MIN=0,MAX=4,INTEGER

Required: True

azimuth¶

float: Azimuth angle [deg]

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

Constraints: MIN=0,MAX=360

Required: array_type<4

dc_ac_ratio¶

float: DC to AC ratio [ratio]

Constraints: POSITIVE

Required: set to 1.1 if not provided.

gcr¶

float: Ground coverage ratio [0..1]

Constraints: MIN=0,MAX=3

Required: set to 0.4 if not provided.

inv_eff¶

float: Inverter efficiency at rated power [%]

Constraints: MIN=90,MAX=99.5

Required: set to 96 if not provided.

losses¶

float: System losses [%]

Info: Total system losses

Constraints: MIN=-5,MAX=99

Required: True

module_type¶

float: Module type [0/1/2]

Info: Standard,Premium,Thin film

Constraints: MIN=0,MAX=2,INTEGER

Required: set to 0 if not provided.

shading_azal¶

sequence[sequence]: Azimuth x altitude beam shading loss [%]

Required: False

shading_diff¶

float: Diffuse shading loss [%]

Required: False

shading_mxh¶

sequence[sequence]: Month x Hour beam shading loss [%]

Required: False

shading_timestep¶

sequence[sequence]: Time step beam shading loss [%]

Required: False

system_capacity¶

float: System size (DC nameplate) [kW]

Required: True

tilt¶

float: Tilt angle [deg]

Options: H=0,V=90

Constraints: MIN=0,MAX=90

Required: array_type<4

Battwatts Group¶

class PySAM.Pvwattsv5Lifetime.Pvwattsv5Lifetime.Battwatts¶

assign() → None¶

Assign attributes from dictionary

Battwatts_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

batt_simple_enable¶

float: Enable Battery [0/1]

Constraints: BOOLEAN

Required: set to 0 if not provided.

AdjustmentFactors Group¶

class PySAM.Pvwattsv5Lifetime.Pvwattsv5Lifetime.AdjustmentFactors¶

assign() → None¶: Assign attributes from dictionary

export() → Dict¶: Export attributes into dictionary

constant¶: type: float

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.Pvwattsv5Lifetime.Pvwattsv5Lifetime.Outputs¶

assign() → None¶

Assign attributes from dictionary

Outputs_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

ac¶: sequence: AC inverter power [W]

ac_annual¶: float: Annual AC system output [kWh]

ac_monthly¶: sequence: AC system output [kWh]

annual_energy¶: float: Annual energy [kWh]

aoi¶: sequence: Angle of incidence [deg]

capacity_factor¶: float: Capacity factor [%]

city¶: str: City

dc¶: sequence: DC array power [W]

dc_monthly¶: sequence: DC array output [kWh]

df¶: sequence: Diffuse irradiance [W/m2]

dn¶: sequence: Beam irradiance [W/m2]

elev¶: float: Site elevation [m]

gh¶: sequence: Global horizontal irradiance [W/m2]

inverter_efficiency¶: float: Inverter efficiency at rated power [%]

inverter_model¶: float: Inverter model specifier

kwh_per_kw¶: float: First year kWh/kW

lat¶: float: Latitude [deg]

location¶: str: Location ID

lon¶: float: Longitude [deg]

monthly_energy¶: sequence: Monthly energy [kWh]

percent_complete¶: float: Estimated percent of total comleted simulation [%]

poa¶: sequence: Plane of array irradiance [W/m2]

poa_monthly¶: sequence: Plane of array irradiance [kWh/m2]

shad_beam_factor¶: sequence: Shading factor for beam radiation

solrad_annual¶: float: Daily average solar irradiance [kWh/m2/day]

solrad_monthly¶: sequence: Daily average solar irradiance [kWh/m2/day]

state¶: str: State

sunup¶: sequence: Sun up over horizon [0/1]

tamb¶: sequence: Ambient temperature [C]

tcell¶: sequence: Module temperature [C]

tpoa¶: sequence: Transmitted plane of array irradiance [W/m2]

ts_shift_hours¶: float: Time offset for interpreting time series outputs [hours]

tz¶: float: Time zone [hr]

wspd¶: sequence: Wind speed [m/s]

Table of Contents

This Page

Pvwattsv5Lifetime¶

Creating an Instance¶

Functions¶

Common Group¶

FinancialAnalysisParameters Group¶

LifetimePV Group¶

Weather Group¶

PVWatts Group¶

Battwatts Group¶

AdjustmentFactors Group¶

Outputs Group¶