Skip to content

Commit 1128ec6

Browse files
committed
Add docstring to restructure_data()
1 parent 3e0cdf8 commit 1128ec6

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

windpowerlib/wind_turbine.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,19 @@ def fetch_turbine_data(self):
132132
"""
133133

134134
def restructure_data():
135+
r"""
136+
Restructures data read from a csv file.
137+
138+
Method creates a two-dimensional DataFrame containing the power
139+
coefficient curve or power curve of the requested wind turbine.
140+
141+
Returns
142+
-------
143+
Tuple (pd.DataFrame, float)
144+
Power curve or power coefficient curve (pd.DataFrame)
145+
and nominal power (float).
146+
147+
"""
135148
df = read_turbine_data(filename=filename)
136149
wpp_df = df[df.turbine_id == self.turbine_name]
137150
if wpp_df.shape[0] == 0:

0 commit comments

Comments
 (0)