Adapt TurbineClusterModelChain docstring

SabineHaas · SabineHaas · commit f692343a6661 · 2019-08-12T15:58:34.000+02:00
diff --git a/windpowerlib/turbine_cluster_modelchain.py b/windpowerlib/turbine_cluster_modelchain.py
@@ -26,54 +26,117 @@ class TurbineClusterModelChain(ModelChain):
         representing the wind turbine cluster.
     wake_losses_model : str or None
         Defines the method for taking wake losses within the farm into
-        consideration. Options: None, 'wind_farm_efficiency' or the name of a
-        wind efficiency curve like 'dena_mean'. Default: 'dena_mean'.
-        Use :py:func:`~.wake_losses.get_wind_efficiency_curve` for all provided
-        wind efficiency curves.
+        consideration.
+
+        * None -
+          Wake losses are not taken into account.
+        * 'wind_farm_efficiency' -
+          See :func:`~.power_curves.wake_losses_to_power_curve` for more
+          information.
+        * 'dena_mean' or name of other wind efficiency curve -
+          See :func:`~.wake_losses.reduce_wind_speed` and
+          :func:`~.wake_losses.get_wind_efficiency_curve` for more information.
+
+       Default: 'dena_mean'.
     smoothing : bool
         If True the power curves will be smoothed before or after the
         aggregation of power curves depending on `smoothing_order`.
+        See :func:`~.power_curves.smooth_power_curve` or more information.
         Default: False.
     block_width : float
         Width between the wind speeds in the sum of the equation in
         :py:func:`~.power_curves.smooth_power_curve`. Default: 0.5.
     standard_deviation_method : str
         Method for calculating the standard deviation for the Gauss
-        distribution. Options: 'turbulence_intensity', 'Staffell_Pfenninger'.
+        distribution.
+
+        * 'turbulence_intensity' -
+          See :func:`~.power_curves.smooth_power_curve` for more information.
+        * 'Staffell_Pfenninger' -
+          See :func:`~.power_curves.smooth_power_curve` for more information.
+
         Default: 'turbulence_intensity'.
     smoothing_order : str
-        Defines when the smoothing takes place if `smoothing` is True. Options:
-        'turbine_power_curves' (to the single turbine power curves),
-        'wind_farm_power_curves'. Default: 'wind_farm_power_curves'.
+        Defines when the smoothing takes place if `smoothing` is True.
+
+        * 'turbine_power_curves' -
+          Smoothing is applied to wind turbine power curves.
+        * 'wind_farm_power_curves' -
+          Smoothing is applied to wind farm power curves.
+
+        Default: 'wind_farm_power_curves'.
 
     Other Parameters
     ----------------
     wind_speed_model : str
-        Parameter to define which model to use to calculate the wind speed
-        at hub height. Valid options are 'logarithmic', 'hellman' and
-        'interpolation_extrapolation'.
+        Parameter to define which model to use to calculate the wind speed at
+        hub height. Valid options are:
+
+        * 'logarithmic' -
+          See :func:`~.wind_speed.logarithmic_profile` for more information.
+          The parameter `obstacle_height` can be used to set the height of
+          obstacles in the surrounding area of the wind turbine.
+        * 'hellman' -
+          See :func:`~.wind_speed.hellman` for more information.
+        * 'interpolation_extrapolation' -
+          See :func:`~.tools.linear_interpolation_extrapolation` for more
+          information.
+        * 'log_interpolation_extrapolation' -
+          See :func:`~.tools.logarithmic_interpolation_extrapolation` for more
+          information.
+
+        Default: 'logarithmic'.
     temperature_model : str
-        Parameter to define which model to use to calculate the temperature
-        of air at hub height. Valid options are 'linear_gradient' and
-        'interpolation_extrapolation'.
+        Parameter to define which model to use to calculate the temperature of
+        air at hub height. Valid options are:
+
+        * 'linear_gradient' -
+          See :func:`~.temperature.linear_gradient` for more
+          information.
+        * 'interpolation_extrapolation' -
+          See :func:`~.tools.linear_interpolation_extrapolation` for more
+          information.
+
+        Default: 'linear_gradient'.
     density_model : str
-        Parameter to define which model to use to calculate the density of
-        air at hub height. Valid options are 'barometric', 'ideal_gas' and
-        'interpolation_extrapolation'.
+        Parameter to define which model to use to calculate the density of air
+        at hub height. Valid options are:
+
+        * 'barometric' -
+          See :func:`~.density.barometric` for more information.
+        * 'ideal_gas' -
+          See :func:`~.density.ideal_gas` for more information.
+        * 'interpolation_extrapolation' -
+          See :func:`~.tools.linear_interpolation_extrapolation` for more
+          information.
+
+        Default: 'barometric'.
     power_output_model : str
-        Parameter to define which model to use to calculate the turbine
-        power output. Valid options are 'power_curve' and
-        'power_coefficient_curve'.
+        Parameter to define which model to use to calculate the turbine power
+        output. Valid options are:
+
+        * 'power_curve' -
+          See :func:`~.power_output.power_curve` for more information. In order
+          to use the density corrected power curve to calculate the power
+          output set parameter `density_correction` to True.
+        * 'power_coefficient_curve' -
+          See :func:`~.power_output.power_coefficient_curve` for more
+          information.
+
+        Default: 'power_curve'.
     density_correction : bool
-        If the parameter is True the density corrected power curve is used
-        for the calculation of the turbine power output.
+        This parameter is only used if the parameter `power_output_model` is
+        'power_curve'. For more information on this parameter see parameter
+        `density_correction` in :func:`~.power_output.power_curve`.
+        Default: False.
     obstacle_height : float
-        Height of obstacles in the surrounding area of the wind turbine in
-        m. Set `obstacle_height` to zero for wide spread obstacles.
+        This parameter is only used if the parameter `wind_speed_model` is
+        'logarithmic'. For more information on this parameter see parameter
+        `obstacle_height` in :func:`~.wind_speed.logarithmic`. Default: 0.
     hellman_exp : float
-        The Hellman exponent, which combines the increase in wind speed due
-        to stability of atmospheric conditions and surface roughness into
-        one constant.
+        This parameter is only used if the parameter `wind_speed_model` is
+        'hellman'. For more information on this parameter see parameter
+        `hellman_exponent` in :func:`~.wind_speed.hellman`. Default: None.
 
     Attributes
     ----------
@@ -83,55 +146,38 @@ class TurbineClusterModelChain(ModelChain):
         representing the wind turbine cluster.
     wake_losses_model : str or None
         Defines the method for taking wake losses within the farm into
-        consideration. Options: None, 'wind_farm_efficiency' or the name of a
-        wind efficiency curve like 'dena_mean'. Default: 'dena_mean'.
-        Use :py:func:`~.wake_losses.get_wind_efficiency_curve` for all provided
-        wind efficiency curves.
+        consideration.
     smoothing : bool
-        If True the power curves will be smoothed before or after the
-        aggregation of power curves depending on `smoothing_order`.
-        Default: False.
+        If True the power curves will be smoothed.
     block_width : float
         Width between the wind speeds in the sum of the equation in
-        :py:func:`~.power_curves.smooth_power_curve`. Default: 0.5.
+        :py:func:`~.power_curves.smooth_power_curve`.
     standard_deviation_method : str
         Method for calculating the standard deviation for the Gauss
-        distribution. Options: 'turbulence_intensity', 'Staffell_Pfenninger'.
-        Default: 'turbulence_intensity'.
+        distribution.
     smoothing_order : str
-        Defines when the smoothing takes place if `smoothing` is True. Options:
-        'turbine_power_curves' (to the single turbine power curves),
-        'wind_farm_power_curves'. Default: 'wind_farm_power_curves'.
+        Defines when the smoothing takes place if `smoothing` is True.
     power_output : :pandas:`pandas.Series<series>`
         Electrical power output of the wind turbine in W.
     power_curve : :pandas:`pandas.Dataframe<frame>` or None
         The calculated power curve of the wind farm.
     wind_speed_model : str
-        Parameter to define which model to use to calculate the wind speed
-        at hub height. Valid options are 'logarithmic', 'hellman' and
-        'interpolation_extrapolation'.
+        Defines which model is used to calculate the wind speed at hub height.
     temperature_model : str
-        Parameter to define which model to use to calculate the temperature
-        of air at hub height. Valid options are 'linear_gradient' and
-        'interpolation_extrapolation'.
+        Defines which model is used to calculate the temperature of air at hub
+        height.
     density_model : str
-        Parameter to define which model to use to calculate the density of
-        air at hub height. Valid options are 'barometric', 'ideal_gas' and
-        'interpolation_extrapolation'.
+        Defines which model is used to calculate the density of air at hub
+        height.
     power_output_model : str
-        Parameter to define which model to use to calculate the turbine
-        power output. Valid options are 'power_curve' and
-        'power_coefficient_curve'.
+        Defines which model is used to calculate the turbine power output.
     density_correction : bool
-        If the parameter is True the density corrected power curve is used
-        for the calculation of the turbine power output.
+        Used to set `density_correction` parameter in
+        :func:`~.power_output.power_curve`.
     obstacle_height : float
-        Height of obstacles in the surrounding area of the wind turbine in
-        m. Set `obstacle_height` to zero for wide spread obstacles.
+        Used to set `obstacle_height` in :func:`~.wind_speed.logarithmic`.
     hellman_exp : float
-        The Hellman exponent, which combines the increase in wind speed due
-        to stability of atmospheric conditions and surface roughness into
-        one constant.
+        Used to set `hellman_exponent` in :func:`~.wind_speed.hellman`.
 
     """
     def __init__(self, power_plant, wake_losses_model='dena_mean',
