Skip to content

Commit cfd40ec

Browse files
committed
Change txt suffix to rst and fix format issues
1 parent 36a0cc8 commit cfd40ec

File tree

12 files changed

+10
-19
lines changed

12 files changed

+10
-19
lines changed

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595

9696
# List of patterns, relative to source directory, that match files and
9797
# directories to ignore when looking for source files.
98-
exclude_patterns = ['_build']
98+
exclude_patterns = ['_build', 'whatsnew/*']
9999

100100
# The reST default role (used for this markup: `text`) to use for all
101101
# documents.

doc/whats_new.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ These are new features and improvements of note in each release
88
:local:
99
:backlinks: top
1010

11-
.. include:: whatsnew/v0-2-0.txt
12-
.. include:: whatsnew/v0-1-3.txt
13-
.. include:: whatsnew/v0-1-2.txt
14-
.. include:: whatsnew/v0-1-1.txt
15-
.. include:: whatsnew/v0-1-0.txt
16-
.. include:: whatsnew/v006.txt
17-
.. include:: whatsnew/v005.txt
11+
.. include:: whatsnew/v0-2-0.rst
12+
.. include:: whatsnew/v0-1-3.rst
13+
.. include:: whatsnew/v0-1-2.rst
14+
.. include:: whatsnew/v0-1-1.rst
15+
.. include:: whatsnew/v0-1-0.rst
16+
.. include:: whatsnew/v006.rst
17+
.. include:: whatsnew/v005.rst
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

doc/whatsnew/v0-2-0.txt renamed to doc/whatsnew/v0-2-0.rst

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,8 @@ v0.2.0 (September 9, 2019)
33

44
API changes
55
#############
6-
* The :class:`~windpowerlib.wind_turbine.WindTurbine` API has been revised. Main changes are that the parameters `fetch_curve` and `data_source` have been removed.
7-
These parameters were formerly used to specify whether the power or power coefficient curve should be retrieved and the source to retrieve them from.
8-
Now per default the power curve and/or power coefficient curve are tried to be retrieved from the oedb turbine library that is provided along with the windpowerlib
9-
and holds turbine data for a large set of wind turbines. Further important changes are the renaming of the parameter `name` to `turbine_type` and the removal
10-
of the `coordinates`.
11-
See the :class:`~windpowerlib.wind_turbine.WindTurbine` docstring and `Initialize wind turbine` in the :ref:`examples_section_label` section for more information.
12-
(`PR 62 <https://github.com/wind-python/windpowerlib/pull/62>`)
13-
* The :class:`~windpowerlib.wind_farm.WindFarm` API has been revised. The `wind_turbine_fleet` parameter can now be provided as a pandas DataFrame
14-
(`PR 63 <https://github.com/wind-python/windpowerlib/pull/63>`_) or as a list using the :func:`~windpowerlib.wind_turbine.WindTurbine.to_group` method
15-
(`PR 68 <https://github.com/wind-python/windpowerlib/pull/68>`_. Furthermore, the option to specify the wind turbine fleet using the total installed capacity
16-
of each turbine type has been added. See the :class:`~windpowerlib.wind_farm.WindFarm` docstring and `Initialize wind farm` in the :ref:`examples_section_label` section for more information.
6+
* The :class:`~windpowerlib.wind_turbine.WindTurbine` API has been revised. Main changes are that the parameters `fetch_curve` and `data_source` have been removed. These parameters were formerly used to specify whether the power or power coefficient curve should be retrieved and the source to retrieve them from. Now per default the power curve and/or power coefficient curve are tried to be retrieved from the oedb turbine library that is provided along with the windpowerlib and holds turbine data for a large set of wind turbines. Further important changes are the renaming of the parameter `name` to `turbine_type` and the removal of the `coordinates`. See the :class:`~windpowerlib.wind_turbine.WindTurbine` docstring and `Initialize wind turbine` in the :ref:`examples_section_label` section for more information. (`PR 62 <https://github.com/wind-python/windpowerlib/pull/62>`)
7+
* The :class:`~windpowerlib.wind_farm.WindFarm` API has been revised. The `wind_turbine_fleet` parameter can now be provided as a pandas DataFrame (`PR 63 <https://github.com/wind-python/windpowerlib/pull/63>`_) or as a list using the :func:`~windpowerlib.wind_turbine.WindTurbine.to_group` method (`PR 68 <https://github.com/wind-python/windpowerlib/pull/68>`_. Furthermore, the option to specify the wind turbine fleet using the total installed capacity of each turbine type has been added. See the :class:`~windpowerlib.wind_farm.WindFarm` docstring and `Initialize wind farm` in the :ref:`examples_section_label` section for more information.
178
* get_installed_power() methods in :class:`~windpowerlib.wind_farm.WindFarm` and :class:`~windpowerlib.wind_turbine_cluster.WindTurbineCluster` were removed. Installed power is instead now directly calculated inside the nominal_power getter.
189
* Removed unnecessary `wake_losses_model` parameter in :py:func:`~.power_curves.wake_losses_to_power_curve`. Whether a constant wind farm efficiency or a wind farm efficiency curve is used is decided by the type of the wind farm efficiency.
1910
* Combined options 'constant_efficiency' and 'power_efficiency_curve' of `wake_losses_model` parameter in :py:func:`~.turbine_cluster_modelchain.TurbineClusterModelChain` to 'wind_farm_efficiency'. Therefore, default value of `wake_losses_model` in :py:func:`~.wind_farm.WindFarm.assign_power_curve` and :py:func:`~.wind_turbine_cluster.WindTurbineCluster.assign_power_curve` changed to 'wind_farm_efficiency'.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)