Skip to content

Commit fd217bf

Browse files
committed
Add to docstrings
1 parent 7047585 commit fd217bf

File tree

3 files changed

+17
-10
lines changed

3 files changed

+17
-10
lines changed

windpowerlib/density.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@ def temperature_gradient(temp_air, temp_height, hub_height):
4242
with:
4343
T: temperature [K], h: height [m]
4444
45-
:math:`h_{T,data}` is the height in which the temperature is measured.
45+
:math:`h_{T,data}` is the height in which the temperature :math:`T_{air}`
46+
is measured and :math:`T_{hub}` is the temperature at hub height
47+
:math:`h_{hub}` of the wind turbine.
4648
4749
Assumptions:
4850
@@ -143,7 +145,7 @@ def rho_barometric(pressure, pressure_height, hub_height, temp_hub):
143145
:math:`h_{p,data}` is the height of the measurement or model data for
144146
pressure, :math:`p_0` the ambient air pressure, :math:`\rho_0` the ambient
145147
density of air, :math:`T_0` the ambient temperature and :math:`T_{hub}` the
146-
temperature at hub height.
148+
temperature at hub height :math:`h_{hub}`.
147149
148150
Assumptions:
149151
@@ -198,8 +200,10 @@ def rho_ideal_gas(pressure, pressure_height, hub_height, temp_hub):
198200
with:
199201
T: temperature [K], :math:`\rho`: density [kg/m³], p: pressure [Pa]
200202
201-
:math:`R_s` is the specific gas constant of dry air (287.058 J/(kg*K)) and
202-
:math:`p_{hub}` is the pressure at hub height.
203+
:math:`h_{p,data}` is the height of the measurement or model data for
204+
pressure, :math:`R_s` is the specific gas constant of dry air
205+
(287.058 J/(kg*K)) and :math:`p_{hub}` is the pressure at hub height
206+
:math:`h_{hub}`.
203207
204208
References
205209
----------

windpowerlib/power_output.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -204,9 +204,11 @@ def p_curve_density_corr(v_wind, rho_hub, p_values):
204204
v: wind speed [m/s], :math:`\rho`: density [kg/m³]
205205
206206
:math:`v_{std}` is the standard wind speed in the power curve
207-
(:math:`v_{std}`, :math:`P_{std}`).
207+
(:math:`v_{std}`, :math:`P_{std}`),
208208
:math:`v_{site}` is the density corrected wind speed for the power curve
209-
(:math:`v_{site}`, :math:`P_{std}`).
209+
(:math:`v_{site}`, :math:`P_{std}`),
210+
:math:`\rho_0` is the ambient density (1.225 kg/m³)
211+
and :math:`\rho_{site}` the density at site conditions (and hub height).
210212
211213
It is assumed that the power output for wind speeds above the maximum
212214
wind speed given in the power curve is zero.

windpowerlib/wind_speed.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,9 @@ def logarithmic_wind_profile(v_wind, v_wind_height, hub_height, z_0,
5757
.. math:: v_{wind,hub}=v_{wind,data}\cdot\frac{\ln\left(\frac{h_{hub}}
5858
{z_{0}}\right)}{\ln\left(\frac{h_{data}}{z_{0}}\right)}
5959
60-
:math:`h_{data}` is the height at which the wind speed
61-
:math:`v_{wind,data}` is measured.
60+
:math:`h_{data}` is the height in which the wind speed
61+
:math:`v_{wind,data}` is measured and :math:`v_{wind,data}` is the wind
62+
speed at hub height :math:`h_{hub}` of the wind turbine.
6263
6364
Parameters `v_wind_height`, `z_0`, `hub_height` and `obstacle_height` have
6465
to be of the same unit.
@@ -123,8 +124,8 @@ def v_wind_hellman(v_wind, v_wind_height, hub_height, hellman_exp=None,
123124
v: wind speed, h: height, :math:`\alpha`: Hellman exponent
124125
125126
:math:`h_{data}` is the height in which the wind speed
126-
:math:`v_{wind,data}` is measured and :math:`h_{hub}` is the hub height of
127-
the wind turbine.
127+
:math:`v_{wind,data}` is measured and :math:`v_{wind,data}` is the wind
128+
speed at hub height :math:`h_{hub}` of the wind turbine.
128129
129130
For the Hellman exponent :math:`\alpha` many studies use a value of 1/7 for
130131
onshore and a value of 1/9 for offshore. The Hellman exponent can also

0 commit comments

Comments
 (0)