Analysis  Shear¶

analysis.shear.
alpha_annual_avg_from_mast_alpha_matrix
(alpha_matrix)[source]¶ Returns a DataFrame of an annual alpha value from a single alpha matrix.
Parameters:  mast: an.MetMast
 Measured data from MetMast.data
Returns:  out: DataFrame
 Average alpha value from a single mast.

analysis.shear.
alpha_annual_profile_from_alpha_time_series
(mast_data, wind_speed_sensors=None, heights=None, match_data=True)[source]¶ Returns monthly mean alpha values from a time series of wind speeds.
Parameters:  mast_data: DataFrame
 Measured data from MetMast.data
 wind_speed_sensors: list, default all anemometers
 Specific wind speeds sensors
 heights: list
 List of the specified sensor heights
Returns:  out: DataFrame
 Mean alpha values indexed by month (annual shear profile)

analysis.shear.
alpha_annual_profile_from_wind_speed_time_series
(mast_data, wind_speed_sensors=None, heights=None, match_data=True)[source]¶ Returns monthly mean alpha values from a time series of wind speeds.
Parameters:  mast_data: DataFrame
 Measured data from MetMast.data
 wind_speed_sensors: list, default all anemometers
 Specific wind speeds sensors
 heights: list
 List of the specified sensor heights
Returns:  out: DataFrame
 Mean alpha values indexed by month (annual shear profile)

analysis.shear.
alpha_dir_profile_from_wind_speed_time_series
(mast_data, wind_dir_sensor, dir_sectors=16, wind_speed_sensors=None, match_data=True)[source]¶ Returns mean alpha values by direction bin from a time series of wind speeds.
Parameters:  mast_data: DataFrame
 Measured data from MetMast.data
 wind_dir_sensors: list
 Specific wind wind vane for directional binning
 dir_sectors: int, default 16
 Number of equally spaced direction sectors in which to bin the mean shear values
 wind_speed_sensors: list, default all anemometers
 Specific wind speeds sensors
 heights: list
 List of the specified sensor heights
Returns:  out: DataFrame
 Mean alpha values indexed by the specified number of direction bins (directional shear profile)

analysis.shear.
alpha_matrix_for_each_sensor_combination_from_mast_data
(mast_data, include_reverse_combinations=False)[source]¶ Returns a DataFrame of annual alpha values, indexed by sensor name, from an.MetMast.data.
Parameters:  mast_data: an.MetMast.data
 Pandas DataFrame of measured data from MetMast.data
Returns:  out: DataFrame
 Alpha values from a single mast, indexed by sensor name

analysis.shear.
alpha_matrix_from_mast_data
(mast_data, include_reverse_combinations=False)[source]¶ Returns a DataFrame of annual alpha values, indexed by sensor name, from an.MetMast.data.
Parameters:  mast_data: an.MetMast.data
 Pandas DataFrame of measured data from MetMast.data
Returns:  out: DataFrame
 Alpha values from a single mast, indexed by sensor name

analysis.shear.
alpha_mean_from_alpha_time_series
(mast_data, wind_speed_sensors=None, heights=None, match_data=True)[source]¶ Returns the mean of monthly means of the alpha time series from wind speed mast_data.
Parameters:  mast_data: DataFrame
 Measured data from MetMast.data
 wind_speed_sensors: list, default all anemometers
 Specific wind speeds sensors
 heights: list
 List of the specified sensor heights
Returns:  out: DataFrame
 Mean of monthly means of an alpha time series

analysis.shear.
alpha_mean_from_wind_speed_time_series
(mast_data, wind_speed_sensors=None, heights=None, match_data=True)[source]¶ Returns alpha values from the mean of monthly means of a time series of wind speeds.
Parameters:  mast_data: DataFrame
 Measured data from MetMast.data
 wind_speed_sensors: list, default all anemometers
 Specific wind speeds sensors
 heights: list
 List of the specified sensor heights
Returns:  out: DataFrame
 Alpha value from the mean of monthly means of a wind speed time series

analysis.shear.
alpha_time_series
(mast_data, wind_speed_sensors=None, heights=None, match_data=True)[source]¶ Returns a time series of alpha values from a time series of wind speeds.
Parameters:  mast_data: DataFrame
 Measured data from MetMast.data
 wind_speed_sensors: list
 Specific wind speeds sensors
 heights: list
 List of the specified sensor heights
Returns:  out: DataFrame
 Time series of alpha values with the same index as the input mast_data

analysis.shear.
check_and_return_wind_dir_data_for_shear
(mast_data, wind_dir_sensor)[source]¶ Perform checks on wind direction data for shear calculations.

analysis.shear.
mast_annual
(mast)[source]¶ Returns a DataFrame of annual alpha values from a single mast indexed by sensor orientation, height, and name.
Parameters:  mast: an.MetMast
 Measured data from MetMast.data
Returns:  out: DataFrame
 Alpha values from a single mast by sensor orientation and height

analysis.shear.
mast_annual_avg
(mast)[source]¶ Returns a DataFrame of an annual alpha value from a single mast, indexed by mast name.
Parameters:  mast: an.MetMast
 Measured data from MetMast.data
Returns:  out: DataFrame
 Average alpha value from a single mast.

analysis.shear.
mast_annual_profile_by_orient
(mast)[source]¶ Returns a DataFrame of annual alpha profiles from a single mast for each sensor orientation.
Parameters:  mast: an.MetMast
 Measured data from MetMast.data
Returns:  out: DataFrame
 Annual alpha profiles for each sensor orientation, indexed by month

analysis.shear.
mast_directional
(mast, wind_dir_sensor=None, dir_sectors=16, wind_speed_sensors=None)[source]¶ Returns a DataFrame of annual alpha values from a single mast, indexed by direction bin. Alpha only calcualted for time steps with valid measurements from each wind speed sensor.
Parameters:  mast: an.MetMast
 Measured data from MetMast.data
 wind_dir_sensors: list, default mast.primary_vane
 Specific wind wind vane for directional binning
 dir_sectors: int, default 16
 Number of equally spaced direction sectors in which to bin the mean shear values
 wind_speed_sensors: list, default all anemometers
 Specific wind speeds sensors
Returns:  out: DataFrame
 Mean alpha values indexed by the specified number of direction bins (directional shear profile)

analysis.shear.
mast_directional_by_orient
(mast, wind_dir_sensor=None, dir_sectors=16)[source]¶ Returns a DataFrame of annual alpha values from a single mast, indexed by direction bin. Alpha only calcualted for time steps with valid measurements from each wind speed sensor.
Parameters:  mast: an.MetMast
 Measured data from MetMast.data
 wind_dir_sensors: list, default mast.primary_vane
 Specific wind wind vane for directional binning
 dir_sectors: int, default 16
 Number of equally spaced direction sectors in which to bin the mean shear values
Returns:  out: DataFrame
 Mean alpha values indexed by the specified number of direction bins (directional shear profile)

analysis.shear.
mast_monthly_by_orient
(mast)[source]¶ Returns a DataFrame of monthly time series of alpha values from a single mast for each sensor orientation. Alpha only calcualted for time steps with valid measurements from each wind speed sensor.
Parameters:  mast: an.MetMast
 Measured data from MetMast.data
Returns:  out: DataFrame
 Mean alpha values for each sensor orientation, indexed by month

analysis.shear.
site_annual
(masts)[source]¶ Returns a DataFrame of annual alpha values from a multiple site masts, indexed by mast, sensor orientation, and height.
Parameters:  masts : list
 List of MetMast objects from which all anemometer data is extracted
Returns:  out: DataFrame
 Alpha values from multiple site masts by mast, sensor orientation, and height

analysis.shear.
site_annual_avg
(masts)[source]¶ Returns a DataFrame of annual alpha values from multiple site masts, indexed by mast.
Parameters:  masts : list
 List of MetMast objects from which all anemometer data is extracted
Returns:  out: DataFrame
 Alpha values from multiple site masts, indexed by mast

analysis.shear.
site_directional
(masts, dir_sectors=16)[source]¶ Returns a DataFrame of annual alpha values from a single mast, indexed by direction bin. Alpha only calcualted for time steps with valid measurements from each wind speed sensor.
Parameters:  masts : list
 List of MetMast objects from which all anemometer data is extracted
 dir_sectors: int, default 16
 Number of equally spaced direction sectors in which to bin the mean shear values
Returns:  out: DataFrame
 Mean alpha values for each mast indexed by the specified number of direction bins (directional shear profile)

analysis.shear.
site_mean
(masts)[source]¶ Returns a DataFrame of the mean annual alpha value from each site masts. Uses all avaialble anemometer combinations.
Parameters:  masts : list
 List of MetMast objects from which all anemometer data is extracted
Returns:  out: DataFrame
 Average annual alpha values from each site mast using all available anemometer combinations

analysis.shear.
site_mean_from_results
(shear_results)[source]¶ Returns a DataFrame of the mean annual alpha value from each site mast from a previously run shear analysis. This allows the user to choose the heights and oreintations used within the final calculated alpha value.
Parameters:  shear results : DataFrame
 DataFrame of shear results from shear.shear_analysis_annual or shear.shear_analysis_site
Returns:  out: DataFrame
 Average annual alpha values from each site mast using all the provided anemometer combinations