Fix documentation

Author: SabineHaas

doc/modules.rst

@@ -132,7 +132,6 @@ Functions for applying wake losses to a wind speed time series.
 
    wake_losses.reduce_wind_speed
    wake_losses.get_wind_efficiency_curve
-   wake_losses.display_wind_efficiency_curves
 
 
 ModelChain

doc/turbine_cluster_modelchain_example_notebook.ipynb

@@ -222,7 +222,7 @@
     "                                           # 'power_efficiency_curve',\n",
     "                                           # 'constant_efficiency' or name of\n",
     "                                           #  a wind efficiency curve\n",
-    "                #  see :py:func:`~.wake_losses.display_wind_efficiency_curves`\n",
+    "                #  see :py:func:`~.wake_losses.get_wind_efficiency_curve`\n",
     "        'smoothing': True,  # False (default) or True\n",
     "        'block_width': 0.5,  # default: 0.5\n",
     "        'standard_deviation_method': 'Staffell_Pfenninger',  #\n",

example/turbine_cluster_modelchain_example.ipynb

@@ -222,7 +222,7 @@
     "                                           # 'power_efficiency_curve',\n",
     "                                           # 'constant_efficiency' or name of\n",
     "                                           #  a wind efficiency curve\n",
-    "                #  see :py:func:`~.wake_losses.display_wind_efficiency_curves`\n",
+    "                #  see :py:func:`~.wake_losses.get_wind_efficiency_curve`\n",
     "        'smoothing': True,  # False (default) or True\n",
     "        'block_width': 0.5,  # default: 0.5\n",
     "        'standard_deviation_method': 'Staffell_Pfenninger',  #\n",

example/turbine_cluster_modelchain_example.py

@@ -152,7 +152,7 @@ class that provides all necessary steps to calculate the power output of a
                                            # 'power_efficiency_curve',
                                            # 'constant_efficiency' or name of
                                            #  a wind efficiency curve
-                #  see :py:func:`~.wake_losses.display_wind_efficiency_curves`
+                #  see :py:func:`~.wake_losses.get_wind_efficiency_curve`
         'smoothing': True,  # False (default) or True
         'block_width': 0.5,  # default: 0.5
         'standard_deviation_method': 'Staffell_Pfenninger',  #

windpowerlib/turbine_cluster_modelchain.py

@@ -27,8 +27,8 @@ class TurbineClusterModelChain(ModelChain):
         consideration. Options: None, 'power_efficiency_curve' or
         'constant_efficiency' or the name of a wind efficiency curve like
         'dena_mean'. Default: 'dena_mean'.
-        Use :py:func:`~.wake_losses.display_wind_efficiency_curves` to see a
-        list of all provided wind efficiency curves.
+        Use :py:func:`~.wake_losses.get_wind_efficiency_curve` for all provided
+        wind efficiency curves.
     smoothing : boolean
         If True the power curves will be smoothed before or after the
         aggregation of power curves depending on `smoothing_order`.
@@ -85,8 +85,8 @@ class TurbineClusterModelChain(ModelChain):
         consideration. Options: None, 'power_efficiency_curve' or
         'constant_efficiency' or the name of a wind efficiency curve like
         'dena_mean'. Default: 'dena_mean'.
-        Use :py:func:`~.wake_losses.display_wind_efficiency_curves` to see a
-        list of all provided wind efficiency curves.
+        Use :py:func:`~.wake_losses.get_wind_efficiency_curve` for all provided
+        wind efficiency curves.
     smoothing : boolean
         If True the power curves will be smoothed before or after the
         aggregation of power curves depending on `smoothing_order`.

windpowerlib/wake_losses.py

@@ -25,8 +25,9 @@ def reduce_wind_speed(wind_speed, wind_efficiency_curve_name='dena_mean'):
     wind_speed : pandas.Series or numpy.array
         Wind speed time series.
     wind_efficiency_curve_name : string
-        Name of the wind efficiency curve. Use get_wind_efficiency_curve() to
-        get all provided wind efficiency curves. Default: 'dena_mean'.
+        Name of the wind efficiency curve. Use
+        :py:func:`~.get_wind_efficiency_curve` to get all provided wind
+        efficiency curves. Default: 'dena_mean'.
 
     Returns
     -------

windpowerlib/wind_turbine.py

@@ -23,8 +23,8 @@ class WindTurbine(object):
     ----------
     name : string
         Name of the wind turbine type.
-        Use get_turbine_types() to see a list of all wind turbines for which
-        power (coefficient) curve data is provided.
+        Use :py:func:`~.get_turbine_types` to see a list of all wind turbines
+        for which power (coefficient) curve data is provided.
     hub_height : float
         Hub height of the wind turbine in m.
     rotor_diameter : None or float
@@ -51,7 +51,7 @@ class WindTurbine(object):
     ----------
     name : string
         Name of the wind turbine type.
-        Use get_turbine_types() to see a list of all wind turbines for which
+        Use :py:func:`~.get_turbine_types` to see a list of all wind turbines for which
         power (coefficient) curve data is provided.
     hub_height : float
         Hub height of the wind turbine in m.