Skip to content

Commit 1bc7cad

Browse files
committed
Link to modelchain docstring
1 parent ee0d90b commit 1bc7cad

File tree

1 file changed

+14
-69
lines changed

1 file changed

+14
-69
lines changed

windpowerlib/turbine_cluster_modelchain.py

Lines changed: 14 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -85,75 +85,20 @@ class TurbineClusterModelChain(ModelChain):
8585
8686
Other Parameters
8787
----------------
88-
wind_speed_model : str
89-
Parameter to define which model to use to calculate the wind speed at
90-
hub height. Valid options are:
91-
92-
* 'logarithmic' -
93-
See :func:`~.wind_speed.logarithmic_profile` for more information.
94-
The parameter `obstacle_height` can be used to set the height of
95-
obstacles in the surrounding area of the wind turbine.
96-
* 'hellman' -
97-
See :func:`~.wind_speed.hellman` for more information.
98-
* 'interpolation_extrapolation' -
99-
See :func:`~.tools.linear_interpolation_extrapolation` for more
100-
information.
101-
* 'log_interpolation_extrapolation' -
102-
See :func:`~.tools.logarithmic_interpolation_extrapolation` for more
103-
information.
104-
105-
Default: 'logarithmic'.
106-
temperature_model : str
107-
Parameter to define which model to use to calculate the temperature of
108-
air at hub height. Valid options are:
109-
110-
* 'linear_gradient' -
111-
See :func:`~.temperature.linear_gradient` for more
112-
information.
113-
* 'interpolation_extrapolation' -
114-
See :func:`~.tools.linear_interpolation_extrapolation` for more
115-
information.
116-
117-
Default: 'linear_gradient'.
118-
density_model : str
119-
Parameter to define which model to use to calculate the density of air
120-
at hub height. Valid options are:
121-
122-
* 'barometric' -
123-
See :func:`~.density.barometric` for more information.
124-
* 'ideal_gas' -
125-
See :func:`~.density.ideal_gas` for more information.
126-
* 'interpolation_extrapolation' -
127-
See :func:`~.tools.linear_interpolation_extrapolation` for more
128-
information.
129-
130-
Default: 'barometric'.
131-
power_output_model : str
132-
Parameter to define which model to use to calculate the turbine power
133-
output. Valid options are:
134-
135-
* 'power_curve' -
136-
See :func:`~.power_output.power_curve` for more information. In order
137-
to use the density corrected power curve to calculate the power
138-
output set parameter `density_correction` to True.
139-
* 'power_coefficient_curve' -
140-
See :func:`~.power_output.power_coefficient_curve` for more
141-
information.
142-
143-
Default: 'power_curve'.
144-
density_correction : bool
145-
This parameter is only used if the parameter `power_output_model` is
146-
'power_curve'. For more information on this parameter see parameter
147-
`density_correction` in :func:`~.power_output.power_curve`.
148-
Default: False.
149-
obstacle_height : float
150-
This parameter is only used if the parameter `wind_speed_model` is
151-
'logarithmic'. For more information on this parameter see parameter
152-
`obstacle_height` in :func:`~.wind_speed.logarithmic`. Default: 0.
153-
hellman_exp : float
154-
This parameter is only used if the parameter `wind_speed_model` is
155-
'hellman'. For more information on this parameter see parameter
156-
`hellman_exponent` in :func:`~.wind_speed.hellman`. Default: None.
88+
wind_speed_model :
89+
See :py:class:`~.modelchain.ModelChain` for more information.
90+
temperature_model :
91+
See :py:class:`~.modelchain.ModelChain` for more information.
92+
density_model :
93+
See :py:class:`~.modelchain.ModelChain` for more information.
94+
power_output_model :
95+
See :py:class:`~.modelchain.ModelChain` for more information.
96+
density_correction :
97+
See :py:class:`~.modelchain.ModelChain` for more information.
98+
obstacle_height :
99+
See :py:class:`~.modelchain.ModelChain` for more information.
100+
hellman_exp :
101+
See :py:class:`~.modelchain.ModelChain` for more information.
157102
158103
Attributes
159104
----------

0 commit comments

Comments
 (0)