Snowmodel

Snowmodel

PySAM.Snowmodel.default(config) Snowmodel

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.Snowmodel.from_existing(data, optional config) Snowmodel

Share data with an existing PySAM class. If optional config is a valid configuration name, load the module’s defaults for that configuration.

PySAM.Snowmodel.new() Snowmodel
PySAM.Snowmodel.wrap(ssc_data_t) Snowmodel

Load data from a PySSC object.

Warning

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

Snowmodel is a wrapper for the SSC compute module cmod_snowmodel.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.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

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 = { 'PV Snow Model': { 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.

PVSnowModel Group

class PySAM.Snowmodel.Snowmodel.PVSnowModel
assign(dict) None

Assign attributes from dictionary, overwriting but not removing values.

PVSnowModel_vals = { var: val, ...}

export() dict

Export attributes into dictionary.

replace(dict) None

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

PVSnowModel_vals = { var: val, ...}

snow_slide_coefficient

Snow Slide Coefficient

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

Type:

float

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(dict) None

Assign attributes from dictionary, overwriting but not removing values.

TimeSeries_vals = { var: val, ...}

export() dict

Export attributes into dictionary.

replace(dict) None

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

TimeSeries_vals = { var: val, ...}

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(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, ...}

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