Adapt tests and cluster modelchain example to changes in WindFarm

Author: birgits

example/turbine_cluster_modelchain_example.ipynb

@@ -139,7 +139,7 @@
     "example_farm_2 = WindFarm(**example_farm_2_data)\n",
     "\n",
     "print('nominal power of first turbine type of example_farm_2: {}'.format(\n",
-    "    example_farm_2.wind_turbine_fleet[0]['wind_turbine'].nominal_power))"
+    "    example_farm_2.wind_turbine_fleet.loc[0, 'wind_turbine'].nominal_power))"
    ]
   },
   {

tests/test_turbine_cluster_modelchain.py

@@ -233,10 +233,6 @@ def test_ignore_wake_losses(self):
             **parameters)
         test_tc_mc.run_model(self.weather_df)
 
-    def test_wind_farm_repr(self):
-        """Test string representation of WindFarm"""
-        assert 'E-126/4200' in repr(wf.WindFarm(**self.test_farm))
-
     def test_wind_turbine_cluster_repr_with_name(self):
         """Test string representation of WindTurbineCluster with a name."""
         assert 'Wind turbine cluster:' in repr(

tests/test_wind_farm.py

@@ -1,5 +1,8 @@
 import pytest
+import pandas as pd
+import numpy as np
 from windpowerlib import WindFarm, WindTurbine
+from windpowerlib.tools import WindpowerlibUserWarning
 
 
 class TestWindFarm:
@@ -13,18 +16,39 @@ def setup_class(self):
                                'turbine_type': 'V90/2000',
                                'nominal_power': 2e6}
 
-    def test_initialization(self):
-        """simple initialization"""
-        test_farm = {'wind_turbine_fleet': [
+    def test_initialization_list(self):
+        """test simple initialization with wind turbine fleet list"""
+        wind_turbine_fleet = [
             {'wind_turbine': WindTurbine(**self.test_turbine),
              'number_of_turbines': 3},
             {'wind_turbine': WindTurbine(**self.test_turbine_2),
-             'number_of_turbines': 2}]}
-        windfarm = WindFarm(**test_farm)
-        assert windfarm.nominal_power == 3 * 4.2e6 + 2 * 2e6
+             'number_of_turbines': 2}]
+        windfarm = WindFarm(wind_turbine_fleet=wind_turbine_fleet)
+        assert 3 * 4.2e6 + 2 * 2e6 == windfarm.nominal_power
+
+    def test_initialization_list_2(self):
+        """test simple initialization with wind turbine fleet list where
+        once number of turbines and once total capacity is provided"""
+        wind_turbine_fleet = [
+            {'wind_turbine': WindTurbine(**self.test_turbine),
+             'number_of_turbines': 3},
+            {'wind_turbine': WindTurbine(**self.test_turbine_2),
+             'total_capacity': 2 * 2e6}]
+        windfarm = WindFarm(wind_turbine_fleet=wind_turbine_fleet)
+        assert 3 * 4.2e6 + 2 * 2e6 == windfarm.nominal_power
+
+    def test_initialization_dataframe(self):
+        """test simple initialization with wind turbine fleet dataframe"""
+        wind_turbine_fleet = pd.DataFrame(
+            data={'wind_turbine': [WindTurbine(**self.test_turbine),
+                                   WindTurbine(**self.test_turbine_2)],
+                  'number_of_turbines': [3, 2]})
+        windfarm = WindFarm(wind_turbine_fleet=wind_turbine_fleet)
+        assert 3 * 4.2e6 + 2 * 2e6 == windfarm.nominal_power
 
     def test_initialization_2(self):
-        """WindTurbine in wind_turbine_fleet not initialized"""
+        """test catching error when WindTurbine in wind_turbine_fleet
+        not initialized"""
         test_farm = {'wind_turbine_fleet': [
             {'wind_turbine': None,
              'number_of_turbines': 3}]}
@@ -33,28 +57,39 @@ def test_initialization_2(self):
             WindFarm(**test_farm)
 
     def test_initialization_3(self):
-        """wind_turbine not specified in wind_turbine_fleet"""
-        test_farm = {'wind_turbine_fleet': [
-            {'wind_turbines': None,
-             'number_of_turbines': 3}]}
-        msg = 'Missing wind_turbine key in wind turbine'
+        """test catching error when wind_turbine not specified in
+        wind_turbine_fleet"""
+        wind_turbine_fleet = pd.DataFrame(
+            data={'wind_turbines': [WindTurbine(**self.test_turbine),
+                                   WindTurbine(**self.test_turbine_2)],
+                  'number_of_turbines': [3, 2]})
+        msg = 'Missing wind_turbine key/column in wind_turbine_fleet'
         with pytest.raises(ValueError, match=msg):
-            WindFarm(**test_farm)
+            WindFarm(wind_turbine_fleet=wind_turbine_fleet)
 
-    def test_initialization_4(self):
-        """deduce number_of_turbines from total_capacity"""
-        total_capacity = 3e6
-        test_farm = {'wind_turbine_fleet': [
-            {'wind_turbine': WindTurbine(**self.test_turbine_2),
-             'total_capacity': total_capacity}]}
-        windfarm = WindFarm(**test_farm)
-        number_of_turbines = total_capacity / \
-                             self.test_turbine_2['nominal_power']
-        assert number_of_turbines == windfarm.wind_turbine_fleet[0][
-            'number_of_turbines']
+    def test_initialization_4(self, recwarn):
+        """test overwriting and raising warning when number_of_turbines and
+        total_capacity in wind turbine fleet do not fit"""
+        wt1 = WindTurbine(**self.test_turbine)
+        wt2 = WindTurbine(**self.test_turbine_2)
+        wind_turbine_fleet = pd.DataFrame(
+            data={'wind_turbine': [wt1, wt2],
+                  'number_of_turbines': [3, 2],
+                  'total_capacity': [3, np.nan]},
+            index=[0, 1])
+        windfarm = WindFarm(wind_turbine_fleet=wind_turbine_fleet)
+        total_cap_wt1_expected = \
+            wt1.nominal_power * wind_turbine_fleet.loc[0, 'number_of_turbines']
+        assert windfarm.wind_turbine_fleet.loc[0, 'total_capacity'] == \
+               total_cap_wt1_expected
+        total_cap_wt2_expected = \
+            wt2.nominal_power * wind_turbine_fleet.loc[1, 'number_of_turbines']
+        assert windfarm.wind_turbine_fleet.loc[1, 'total_capacity'] == \
+               total_cap_wt2_expected
+        assert recwarn.pop(WindpowerlibUserWarning)
 
     def test_initialization_5(self):
-        """deducing number_of_turbines from total_capacity fails"""
+        """test catching error when number of turbines cannot be deduced"""
         wt = WindTurbine(**self.test_turbine)
         wt.nominal_power = None
         test_farm = {'wind_turbine_fleet': [
@@ -65,11 +100,12 @@ def test_initialization_5(self):
             WindFarm(**test_farm)
 
     def test_initialization_6(self):
-        """number_of_turbines and total_capacity not given"""
+        """test catching error when neither number_of_turbines nor
+        total_capacity is provided"""
         test_farm = {'wind_turbine_fleet': [
             {'wind_turbine': WindTurbine(**self.test_turbine),
              'number_of_turbine': 3e6}]}
-        msg = 'Please provide `number_of_turbines` or `total_capacity`'
+        msg = 'Number of turbines of type '
         with pytest.raises(ValueError, match=msg):
             WindFarm(**test_farm)
 
@@ -84,3 +120,10 @@ def test_mean_hub_height(self):
         assert 97.265 == pytest.approx(
             windfarm.mean_hub_height().hub_height, 1e-3)
 
+    def test_repr(self):
+        """Test string representation of WindFarm"""
+        test_fleet = [{'wind_turbine': WindTurbine(**self.test_turbine),
+                       'number_of_turbines': 2}]
+        assert 'E-126/4200' in repr(WindFarm(wind_turbine_fleet=test_fleet))
+
+

windpowerlib/wind_turbine_cluster.py

@@ -127,8 +127,8 @@ def mean_hub_height(self):
 
         """
         self.hub_height = np.exp(sum(
-            np.log(wind_farm.hub_height) * wind_farm.get_installed_power() for
-            wind_farm in self.wind_farms) / self.get_installed_power())
+            np.log(wind_farm.hub_height) * wind_farm.nominal_power for
+            wind_farm in self.wind_farms) / self.nominal_power)
         return self
 
     def get_installed_power(self):
@@ -143,7 +143,7 @@ def get_installed_power(self):
 
         """
         for wind_farm in self.wind_farms:
-            wind_farm.nominal_power = wind_farm.get_installed_power()
+            wind_farm.nominal_power = wind_farm.nominal_power
         return sum(wind_farm.nominal_power for wind_farm in self.wind_farms)
 
     def assign_power_curve(self, wake_losses_model='wind_farm_efficiency',