Wfreader

Wfreader

PySAM.Wfreader.default(config) → Wfreader

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

PySAM.Wfreader.new() → Wfreader

PySAM.Wfreader.wrap(ssc_data_t) → Wfreader: Load data from a PySSC object.

Warning

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

Wfreader is a wrapper for the SSC compute module cmod_wfreader.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.Wfreader.Wfreader

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

WeatherReader Group

class PySAM.Wfreader.Wfreader.WeatherReader

assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

WeatherReader_vals = { var: val, ...}

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

replace(dict) → None

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

WeatherReader_vals = { var: val, ...}

file_name

local weather file path

Constraints: LOCAL_FILE

Required: True

Type:: str

header_only

read header only [0/1]

Constraints: BOOLEAN

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

Type:: float

Outputs Group

class PySAM.Wfreader.Wfreader.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, ...}

albedo

Ground Reflectance [frac]

Type:: sequence

annual_albedo

Average albedo

Type:: float

annual_beam

Average daily beam normal [kWh/m2/day]

Type:: float

annual_diff

Average daily diffuse [kWh/m2/day]

Type:: float

annual_glob

Average daily global horizontal [kWh/m2/day]

Type:: float

annual_snow

Maximum snow depth [cm]

Type:: float

annual_tdry

Average dry bulb temperature [‘C]

Type:: float

annual_twet

Average wet bulb temperature [‘C]

Type:: float

annual_wspd

Average wind speed [m/s]

Type:: float

beam

Beam Normal Irradiance [W/m2]

Type:: sequence

city

City

Type:: str

country

Country

Type:: str

day

Day [dy]

Type:: sequence

description

Description

Type:: str

diff

Diffuse Horizontal Irradiance [W/m2]

Type:: sequence

elev

Elevation [m]

Type:: float

format

File format

Type:: str

glob

Global Horizontal Irradiance [W/m2]

Type:: sequence

hour

Hour [hr]

Type:: sequence

lat

Latitude [deg]

Type:: float

location

Location ID

Type:: str

lon

Longitude [deg]

Type:: float

minute

Minute [min]

Type:: sequence

month

Month [mn]

Type:: sequence

nrecords

Number of records

Type:: float

poa

Plane of Array Irradiance [W/m2]

Type:: sequence

pres

Atmospheric Pressure [millibar]

Type:: sequence

rhum

Relative Humidity [%]

Type:: sequence

snow

Snow Depth [cm]

Type:: sequence

source

Source

Type:: str

start

Start [sec]

Type:: float

state

State

Type:: str

step

Step [sec]

Type:: float

tdew

Temperature Dew Point [‘C]

Type:: sequence

tdry

Temperature Dry Bulb [‘C]

Type:: sequence

twet

Temperature Wet Bulb [‘C]

Type:: sequence

tz

Time zone [hr]

Type:: float

url

URL

Type:: str

wdir

Wind Direction [deg]

Type:: sequence

wspd

Wind Speed [m/s]

Type:: sequence

year

Year [yr]

Type:: sequence