flasc.utilities.energy_ratio_utilities.check_compute_energy_ratio_inputs

flasc.utilities.energy_ratio_utilities.check_compute_energy_ratio_inputs#

flasc.utilities.energy_ratio_utilities.check_compute_energy_ratio_inputs(df_, ref_turbines, test_turbines, wd_turbines, ws_turbines, use_predefined_ref, use_predefined_wd, use_predefined_ws, wd_step, wd_min, wd_max, ws_step, ws_min, ws_max, bin_cols_in, weight_by, df_freq, wd_bin_overlap_radius, uplift_pairs, uplift_names, uplift_absolute, N, percentiles, remove_all_nulls)[source]#

Check the inputs to compute_energy_ratio.

Check inputs to compute_energy_ratio. Inputs reflect inputs to compute_energy_ratio, with exception of df_, which is passed directly instead of er_in.

All the inputs of compute_energy_ratio are checked for validity. This function does not check every input, although they are all accepted.

Parameters:

  • df (pl.DataFrame) -- The Polars DataFrame

  • ref_turbines (list) -- A list of the reference turbine columns

  • test_turbines (list) -- A list of the test turbine columns

  • wd_turbines (list) -- A list of the wind direction columns

  • ws_turbines (list) -- A list of the wind speed columns

  • use_predefined_ref (bool) -- Whether to use predefined reference turbines

  • use_predefined_wd (bool) -- Whether to use predefined wind direction turbines

  • use_predefined_ws (bool) -- Whether to use predefined wind speed turbines

  • wd_step (float) -- Step size for binning wind direction

  • wd_min (float) -- Minimum wind direction

  • wd_max (float) -- Maximum wind direction

  • ws_step (float) -- Step size for binning wind speed

  • ws_min (float) -- Minimum wind speed

  • ws_max (float) -- Maximum wind speed

  • bin_cols_in (list) -- A list of columns to bin

  • weight_by (str) -- A string indicating how to weight the bins

  • df_freq (pl.DataFrame) -- A DataFrame containing frequency data

  • wd_bin_overlap_radius (float) -- The radius for overlapping wind direction bins

  • uplift_pairs (list) -- A list of uplift pairs

  • uplift_names (list) -- A list of uplift names

  • uplift_absolute (bool) -- Whether to use absolute uplift

  • N (int) -- Number of bootstrapping iterations

  • percentiles (list) -- A list of percentiles to calculate from bootstrap

  • remove_all_nulls (bool) -- Whether to remove all nulls

Contents