Add parameters to display function

Author: SabineHaas

tests/test_turbine_cluster_modelchain.py

@@ -85,8 +85,6 @@ def test_run_model(self):
         test_tc_mc.run_model(self.weather_df)
         assert_series_equal(test_tc_mc.power_output, power_output_exp)
 
-        # TODO: Test power efficiency curve?
-
         # Test smoothing
         parameters['smoothing'] = 'True'
         test_wind_farm = wf.WindFarm(**self.test_farm)

tests/test_wake_losses.py

@@ -3,8 +3,8 @@
 import pytest
 from pandas.util.testing import  assert_series_equal
 
-from windpowerlib.wake_losses import reduce_wind_speed
-import windpowerlib.wind_turbine as wt
+from windpowerlib.wake_losses import (reduce_wind_speed,
+                                      display_wind_efficiency_curves)
 
 class TestWakeLosses:
 
@@ -30,3 +30,7 @@ def test_reduce_wind_speed(self):
         with pytest.raises(ValueError):
             parameters['wind_efficiency_curve_name'] = 'dena_misspelled'
             reduce_wind_speed(**parameters)
+
+    def test_display_wind_efficiency_curves(self):
+        # This test just runs the function
+        display_wind_efficiency_curves()

windpowerlib/power_output.py

@@ -142,7 +142,6 @@ def power_curve(wind_speed, power_curve_wind_speeds, power_curve_values,
 
 def power_curve_density_correction(wind_speed, power_curve_wind_speeds,
                                    power_curve_values, density):
-    # possible TODO: add density correction for stall controlled wind turbines
     r"""
     Calculates the turbine power output using a density corrected power curve.
 

windpowerlib/wake_losses.py

@@ -10,6 +10,7 @@
 import numpy as np
 import pandas as pd
 import os
+import logging
 
 try:
     from matplotlib import pyplot as plt
@@ -117,9 +118,18 @@ def get_wind_efficiency_curve(curve_name='dena_mean'):
     return efficiency_curve
 
 
-def display_wind_efficiency_curves():
+def display_wind_efficiency_curves(print_out=False, plot=False):
     r"""
-    Displays all wind efficiency curves available in the windpowerlib.
+    Displays all names of wind efficiency curves available in the windpowerlib.
+
+    Parameters
+    ----------
+    print_out : Boolean
+        If True the values of the wind efficiency curves are printed. Default:
+        False.
+    plot : Boolean
+        If True all available wind efficiency curves are plotted - if
+        matplotlib is installed. Default: False.
 
     Notes
     -----
@@ -151,7 +161,9 @@ def display_wind_efficiency_curves():
     curves_list.extend([col for col in knorr_df if 'wind_speed' not in col])
     print("Names of the provided wind efficiency curves are the " +
           "following: {}".format(curves_list))
-    if plt:
+    print("To plot the different wind efficiency curves use this function " +
+           "with the parameter plot=True.")
+    if plt and plot is True:
         # Create data frames for plot
         dena_df.set_index('wind_speed', inplace=True)
         knorr_df.set_index('wind_speed', inplace=True)
@@ -162,9 +174,10 @@ def display_wind_efficiency_curves():
         plt.xlabel('Wind speed m/s')
         plt.show()
     else:
+        logging.debug("Matplotlib is not installed.")
+    if print_out is True:
         print(dena_df)
         print(knorr_df)
 
-
 if __name__ == "__main__":
     display_wind_efficiency_curves()