Skip to content

Commit 0049b90

Browse files
committed
Add to docstrings
1 parent 10ee198 commit 0049b90

File tree

2 files changed

+26
-3
lines changed

2 files changed

+26
-3
lines changed

windpowerlib/tools.py

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ def gaussian_distribution(function_variable, standard_deviation, mean=0):
105105
----------
106106
.. [1] Berendsen, H.: "A Student's Guide to Data and Error Analysis".
107107
New York, Cambridge University Press, 2011, p. 37
108-
108+
109109
# TODO: add references
110110
111111
"""
@@ -118,6 +118,29 @@ def estimate_turbulence_intensity(height, roughness_length):
118118
"""
119119
Calculate turbulence intensity.
120120
121+
Parameters
122+
----------
123+
height : Float
124+
Height above ground in m at which the turbulence intensity is
125+
calculated.
126+
roughness_length : pandas.Series or numpy.array or float
127+
Roughness length.
128+
129+
Notes
130+
-----
131+
The following equation is used [1]_:
132+
133+
.. math:: TI = \frac{1}{ln \left(\frac{h}{z_\text{0}} \right)}
134+
135+
with:
136+
TI: turbulence intensity, h: height, :math:`z_{0}`: roughness length
137+
138+
References
139+
----------
140+
.. [1] Knorr, K.: "Modellierung von raum-zeitlichen Eigenschaften der
141+
Windenergieeinspeisung für wetterdatenbasierte
142+
Windleistungssimulationen". Universität Kassel, Diss., 2016,
143+
p. 88
144+
121145
"""
122-
# TODO: Search other possibilities for TI.
123146
return 1 / (np.log(height / roughness_length))

windpowerlib/wind_speed.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ def logarithmic_profile(wind_speed, wind_speed_height, hub_height,
4242
4343
Notes
4444
-----
45-
The following equation is used [1]_:
45+
The following equation is used [1]_, [2]_, [3]_:
4646
4747
.. math:: v_{wind,hub}=v_{wind,data}\cdot
4848
\frac{\ln\left(\frac{h_{hub}-d}{z_{0}}\right)}{\ln\left(

0 commit comments

Comments
 (0)