Snowmodel¶
Wrapper for SAM Simulation Core model: cmod_snowmodel.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.
Snowmodel model description
Snowmodel
-
PySAM.Snowmodel.
default
(config) → Snowmodel¶ Use financial config-specific default attributes
-
PySAM.Snowmodel.
from_existing
(data, optional config) → Snowmodel¶ Share underlying data with an existing PySAM class. If config provided, default attributes are loaded otherwise.
-
PySAM.Snowmodel.
new
() → Snowmodel¶
-
PySAM.Snowmodel.
wrap
(ssc_data_t) → Snowmodel¶ Use existing PySSC data
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap
Functions¶
-
class
PySAM.Snowmodel.
Snowmodel
¶ 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 = { 'PV Snow Model': { 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.
-
PVSnowModel Group¶
-
class
PySAM.Snowmodel.Snowmodel.
PVSnowModel
¶ -
assign
() → None¶ Assign attributes from dictionary
PVSnowModel_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
snowdepth
¶ Snow Depth [cm]
Constraints: LENGTH=8760
Required: True
Type: sequence
-
subarray1_nmody
¶ Number of Modules in a Row
Required: True
Type: float
-
subarray1_poa_shaded
¶ Plane of Array Incidence [W/m^2]
Constraints: LENGTH=8760
Required: True
Type: sequence
-
subarray1_surf_tilt
¶ Surface Tilt [Degrees]
Constraints: LENGTH=8760
Required: True
Type: sequence
-
subarray1_tilt
¶ Base tilt [Degrees]
Required: True
Type: float
-
subarray1_track_mode
¶ Tracking Mode
Required: True
Type: float
-
tdry
¶ Ambient Temperature [Degrees Celsius]
Constraints: LENGTH=8760
Required: True
Type: sequence
-
wspd
¶ Wind Speed [m/s]
Constraints: LENGTH=8760
Required: True
Type: sequence
-
TimeSeries Group¶
-
class
PySAM.Snowmodel.Snowmodel.
TimeSeries
¶ -
assign
() → None¶ Assign attributes from dictionary
TimeSeries_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
hourly_gen
¶ Hourly Energy [kwh]
Constraints: LENGTH=8760
Required: True
Type: sequence
-
sunup
¶ Sun up over horizon [0/1]
Required: True
Type: sequence
-
Outputs Group¶
-
class
PySAM.Snowmodel.Snowmodel.
Outputs
¶ -
assign
() → None¶ Assign attributes from dictionary
Outputs_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
annual_energy
¶ Annual Energy [kwh]
Type: float
-
annual_energy_before_snow
¶ Annual Energy Without Snow Losses [kwh]
Type: float
-
hourly_energy_before_snow
¶ Hourly Energy Without Snow Loss [kwh]
Type: sequence
-
hourly_gen
¶ Hourly Energy [kwh]
Type: sequence
-
monthly_energy
¶ Monthly Energy [kwh]
Type: sequence
-
monthly_energy_before_snow
¶ Monthly Energy Without Snow Loss [kwh]
Type: sequence
-