WindFileReader¶
Wrapper for SAM Simulation Core model: cmod_wind_file_reader.cpp
Input Consistency Warning¶
As described in Possible Problems, some input parameters are interdependent but the equations that enforce consistency are not available in this PySAM module. Therefore, the onus is on the PySAM user to check that interdependencies are correctly handled. The variables which may require additional logic include:
Provided for each of these inputs is a list of other inputs that are potentially interdependent.
Creating an Instance¶
Refer to the Initializing a Model page for details on the different ways to create an instance of a PySAM class.
WindFileReader model description
WindFileReader
-
PySAM.WindFileReader.default(config) → WindFileReader¶ Use default attributes None
-
PySAM.WindFileReader.from_existing(data, optional config) → WindFileReader¶ Share underlying data with an existing PySAM class. If config provided, default attributes are loaded otherwise.
-
PySAM.WindFileReader.new() → WindFileReader¶
-
PySAM.WindFileReader.wrap(ssc_data_t) → WindFileReader¶ Use existing PySSC data
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap
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
-
unassign(name) → None¶ Unassign a value in any of the variable groups.
-
value(name, optional value) → Union[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() → None¶ Assign attributes from dictionary
WeatherReader_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
file_name¶ local weather file path
Constraints: LOCAL_FILE
Required: True
Type: str
-
interpolate¶ interpolate to closest height measured? [m]
Constraints: BOOLEAN
Required: True 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: If not provided, assumed to be 0
Type: float
-
Outputs Group¶
-
class
PySAM.WindFileReader.WindFileReader.Outputs¶ -
assign() → None¶ Assign attributes from dictionary
Outputs_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
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
-