File tree Expand file tree Collapse file tree 2 files changed +18
-4
lines changed
Expand file tree Collapse file tree 2 files changed +18
-4
lines changed Original file line number Diff line number Diff line change @@ -72,14 +72,15 @@ power curve or power coefficient curve needed by the :py:class:`~.wind_turbine.W
7272
7373.. _create_input_types_label :
7474
75- Create Data Container
75+ Data Container
7676=====================
7777
78- Create groups to be used as an input in classes und functions.
78+ Create data container to be used as an input in classes und functions.
7979
8080.. autosummary ::
8181 :toctree: temp/
8282
83+ wind_turbine.WindTurbineGroup
8384 wind_turbine.WindTurbine.to_group
8485
8586.. _wind_farm_label :
@@ -245,4 +246,4 @@ TurbineClusterModelChain example
245246The ``turbine_cluster_modelchain_example `` consists of the following functions
246247as well as it uses functions of the ``modelchain_example ``.
247248
248- .. include :: example_2.rst
249+ .. include :: example_2.rst
Original file line number Diff line number Diff line change @@ -269,11 +269,24 @@ class WindTurbineGroup(NamedTuple('WindTurbineGroup', [
269269 """
270270 A simple data container to define more than one turbine of the same type.
271271 Use the :func:`~windpowerlib.wind_turbine.WindTurbine.to_group` method to
272- easily create a WindTurbineGroup from a :class:`~windpowerlib.wind_turbine.WindTurbine` object.
272+ easily create a WindTurbineGroup from a
273+ :class:`~windpowerlib.wind_turbine.WindTurbine` object.
274+
275+ Parameters
276+ ----------
277+ 'wind_turbine' : WindTurbine
278+ A WindTurbine object with all necessary attributes.
279+ 'number_of_turbines' : float
280+ The number of turbines. The number is not restricted to integer values.
273281 """
274282 __slots__ = ()
275283
276284
285+ WindTurbineGroup .wind_turbine .__doc__ = ':class:`~windpowerlib.wind_farm.WindFarm`'
286+ WindTurbineGroup .number_of_turbines .__doc__ = (
287+ 'Number of turbines of type WindTurbine' )
288+
289+
277290def get_turbine_data_from_file (turbine_type , path ):
278291 r"""
279292 Fetches turbine data from a csv file.
You can’t perform that action at this time.
0 commit comments