WindFileReader
WindFileReader
- PySAM.WindFileReader.default(config) WindFileReader
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.WindFileReader.from_existing(data, optional config) WindFileReader
Share data with an existing PySAM class. If
optional config
is a valid configuration name, load the module’s defaults for that configuration.
- PySAM.WindFileReader.new() WindFileReader
- PySAM.WindFileReader.wrap(ssc_data_t) WindFileReader
Load data from a PySSC object.
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap()
WindFileReader is a wrapper for the SSC compute module cmod_wind_file_reader.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.WindFileReader.WindFileReader
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.WindFileReader.WindFileReader.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
- interpolate
interpolate to closest height measured? [m]
Constraints: BOOLEAN
Required: Required if scan_header_only=0
- Type:
float
- requested_ht
requested measurement height [m]
Required: True
- Type:
float
- scan_header_only
only reader headers [0/1]
Constraints: BOOLEAN
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
- Type:
float
Outputs Group
- class PySAM.WindFileReader.WindFileReader.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, ...}
- city
City
- Type:
str
- closest_dir_meas_ht
Height of closest direction meas in file [m]
- Type:
float
- closest_speed_meas_ht
Height of closest speed meas in file [m]
- Type:
float
- country
Country
- Type:
str
- description
Description
- Type:
str
- elev
Elevation [m]
- Type:
float
- lat
Latitude [deg]
- Type:
float
- location_id
Location ID
- Type:
str
- lon
Longitude [deg]
- Type:
float
- pressure
Atmospheric Pressure [atm]
- Type:
sequence
- state
State
- Type:
str
- temperature
Temperature [‘C]
- Type:
sequence
- wind_direction
Wind Direction [deg]
- Type:
sequence
- wind_speed
Wind Speed [m/s]
- Type:
sequence
- year
Calendar year of data
- Type:
float