Merge branch 'dev' into features/revise_example

Author: Birgit Schachler

doc/index.rst

@@ -4,7 +4,7 @@ Welcome to the windpowerlib documentation!
 Contents:
 
 .. toctree::
-   :maxdepth: 5
+   :maxdepth: 2
    :glob:   
 
    getting_started

doc/modules.rst

@@ -1,5 +1,8 @@
 .. currentmodule:: windpowerlib
 
+#############
+API
+#############
 
 Classes
 =========
@@ -8,7 +11,7 @@ Classes
    :toctree: temp/
 
    wind_turbine.WindTurbine
-   modelchain.Modelchain
+   modelchain.ModelChain
 
 
 Density
@@ -66,28 +69,28 @@ Functions for calculating power output of a wind turbine.
    power_output.p_curve_density_corr
 
 
-Modelchain
+ModelChain
 ==============
 
-Creating a Modelchain object.
+Creating a ModelChain object.
 
 .. autosummary::
    :toctree: temp/
 
-   modelchain.Modelchain
+   modelchain.ModelChain
 
-Running the modelchain.
+Running the ModelChain.
 
 .. autosummary::
    :toctree: temp/
 
-   modelchain.Modelchain.run_model
+   modelchain.ModelChain.run_model
 
-Methods of the Modelchain object.
+Methods of the ModelChain object.
 
 .. autosummary::
    :toctree: temp/
 
-   modelchain.Modelchain.rho_hub
-   modelchain.Modelchain.v_wind_hub
-   modelchain.Modelchain.turbine_power_output
+   modelchain.ModelChain.rho_hub
+   modelchain.ModelChain.v_wind_hub
+   modelchain.ModelChain.turbine_power_output

windpowerlib/density.py

@@ -20,7 +20,7 @@ def temperature_gradient(temp_air, temp_height, hub_height):
 
     Parameters
     ----------
-    temp_air : pandas.Series or array
+    temp_air : pandas.Series or array-like
         Air temperature in K.
     temp_height : float
         Height in m for which the parameter `temp_air` applies.
@@ -70,9 +70,9 @@ def temperature_interpol(temp_air_1, temp_air_2,
 
     Parameters
     ----------
-    temp_air_1 : pandas.Series or array
+    temp_air_1 : pandas.Series or array-like
         Air temperature.
-    temp_air_2 : pandas.Series or array
+    temp_air_2 : pandas.Series or array-like
         Second air temperature for interpolation.
     temp_air_height_1 : float
         Height for which the parameter `temp_air_1` applies.
@@ -116,13 +116,13 @@ def rho_barometric(pressure, pressure_height, hub_height, temp_hub):
 
     Parameters
     ----------
-    pressure : pandas.Series or array
+    pressure : pandas.Series or array-like
         Air pressure in Pa.
     pressure_height : float
         Height in m for which the parameter `pressure` applies.
     hub_height : float
         Hub height of wind turbine in m.
-    temp_hub : pandas.Series or array
+    temp_hub : pandas.Series or array-like
         Air temperature at hub height in K.
 
     Returns
@@ -172,13 +172,13 @@ def rho_ideal_gas(pressure, pressure_height, hub_height, temp_hub):
 
     Parameters
     ----------
-    pressure : pandas.Series or array
+    pressure : pandas.Series or array-like
         Air pressure in Pa.
     pressure_height : float
         Height in m for which the parameter `pressure` applies.
     hub_height : float
         Hub height of wind turbine in m.
-    temp_hub : pandas.Series or array
+    temp_hub : pandas.Series or array-like
         Air temperature at hub height in K.
 
     Returns

windpowerlib/power_output.py

@@ -21,9 +21,9 @@ def cp_curve(v_wind, rho_hub, d_rotor, cp_values):
 
     Parameters
     ----------
-    v_wind : pandas.Series or array
+    v_wind : pandas.Series or array-like
         Wind speed at hub height in m/s.
-    rho_hub : pandas.Series or array
+    rho_hub : pandas.Series or array-like
         Density of air at hub height in kg/m³.
     d_rotor : float
         Diameter of rotor in m.
@@ -85,7 +85,7 @@ def cp_curve_density_corr(v_wind, rho_hub, d_rotor, cp_values):
     ----------
     v_wind : pandas.Series or array
         Wind speed at hub height in m/s.
-    rho_hub : pandas.Series or array
+    rho_hub : pandas.Series or array-like
         Density of air at hub height in kg/m³.
     cp_values : pandas.DataFrame
         Power coefficient curve of the wind turbine.

windpowerlib/tests/modelchain_tests.py

@@ -91,14 +91,14 @@ def test_rho_hub(self):
 
     def test_run_model(self):
         # Test with default parameters of modelchain (power curve)
-        power_output_exp = pd.Series(data=[1731.8874, 3820.15227])
+        power_output_exp = pd.Series(data=[1731887.39768, 3820152.27489])
         test_mc = mc.ModelChain(self.test_wt)
         test_mc.run_model(self.weather, self.data_height)
         assert_series_equal(test_mc.power_output, power_output_exp)
 
     def test_different_models(self):
         # Test with density corrected power curve
-        power_output_exp = pd.Series(data=[1430.31277, 3746.07521])
+        power_output_exp = pd.Series(data=[1430312.76771, 3746075.21279])
         self.test_modelchain['density_corr'] = True
         test_wt = wt.WindTurbine(**self.test_turbine)
         test_mc = mc.ModelChain(test_wt, **self.test_modelchain)

windpowerlib/wind_speed.py

@@ -23,13 +23,13 @@ def logarithmic_wind_profile(v_wind, v_wind_height, hub_height, z_0,
 
     Parameters
     ----------
-    v_wind : pandas.Series or array
+    v_wind : pandas.Series or array-like
         Wind speed time series.
     v_wind_height : float
         Height for which the parameter `v_wind` applies.
     hub_height : float
         Hub height of wind turbine.
-    z_0 : pandas.Series or array or float
+    z_0 : pandas.Series or array-like or float
         Roughness length.
     obstacle_height : float
         Height of obstacles in the surrounding area of the wind turbine. Set
@@ -93,7 +93,7 @@ def v_wind_hellman(v_wind, v_wind_height, hub_height, hellman_exp=None,
 
     Parameters
     ----------
-    v_wind : pandas.Series or array
+    v_wind : pandas.Series or array-like
         Wind speed time series.
     v_wind_height : float
         Height for which the parameter `v_wind` applies.