WaveFileReader¶
Load wave resource data from file. Data can be in either probability distribution format or 3-hour time series arrays
-
PySAM.WaveFileReader.
default
(config) → WaveFileReader¶ Load defaults for the configuration
config
. Available configurations are:- “MEwaveBatterySingleOwner”
- “MEwaveLCOECalculator”
- “MEwaveNone”
- “MEwaveSingleOwner”
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.WaveFileReader.
from_existing
(data, optional config) → WaveFileReader¶ Share data with an existing PySAM class. If
optional config
is a valid configuration name, load the module’s defaults for that configuration.
-
PySAM.WaveFileReader.
new
() → WaveFileReader¶
-
PySAM.WaveFileReader.
wrap
(ssc_data_t) → WaveFileReader¶ Load data from a PySSC object.
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap()
WaveFileReader is a wrapper for the SSC compute module cmod_wave_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.WaveFileReader.
WaveFileReader
¶ 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
-
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) → Union[None, float, dict, sequence, str]¶ Get or set by name a value in any of the variable groups.
-
WeatherReader Group¶
-
class
PySAM.WaveFileReader.WaveFileReader.
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, ...}
-
use_specific_wf_wave
¶ user specified file [0/1]
Constraints: INTEGER,MIN=0,MAX=1
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
Type: float
-
wave_resource_filename
¶ File path with Wave Height x Period Distribution as 2-D PDF
Constraints: LOCAL_FILE
Required: Required if wave_resource_model_choice=0
Type: str
-
wave_resource_filename_ts
¶ File path with 3-hour Wave Height and Period data as Time Series array
Constraints: LOCAL_FILE
Required: Required if wave_resource_model_choice=1
Type: str
-
wave_resource_model_choice
¶ Joint PDF or 3-hour wave resource data [0/1]
Constraints: INTEGER
Required: False. Automatically set to 1 if not assigned explicitly or loaded from defaults.
Type: float
-
Outputs Group¶
-
class
PySAM.WaveFileReader.WaveFileReader.
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, ...}
-
average_power_flux
¶ Average power flux [kW/m]
Type: float
-
bathymetry
¶ Bathymetry
Type: str
-
city
¶ City
Type: str
-
country
¶ Country
Type: str
-
data_source
¶ Data source
Type: str
-
day
¶ Day [dy]
Type: sequence
-
distance_to_shore_file
¶ Distance to shore [m]
Type: float
-
energy_period
¶ Wave period time series data [s]
Type: sequence
-
hour
¶ Hour [hr]
Type: sequence
-
lat
¶ Latitude [deg]
Type: float
-
location_id
¶ Location ID
Type: float
-
lon
¶ Longitude [deg]
Type: float
-
minute
¶ Minute [min]
Type: sequence
-
month
¶ Month [mn]
Type: sequence
-
name
¶ Name
Type: str
-
nearby_buoy_number
¶ Nearby buoy number
Type: str
-
notes
¶ Notes
Type: str
-
number_hours
¶ Number of hours in wave time series
Type: float
-
number_records
¶ Number of records in wave time series
Type: float
-
sea_bed
¶ Sea bed
Type: str
-
significant_wave_height
¶ Wave height time series data [m]
Type: sequence
-
state
¶ State
Type: str
-
tz
¶ Time zone
Type: float
-
water_depth_file
¶ Water depth [m]
Type: float
-
wave_resource_matrix
¶ Frequency distribution of resource [m/s]
Type: sequence[sequence]
-
year
¶ Year [yr]
Type: sequence
-