You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+38-12Lines changed: 38 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,44 +26,71 @@ Go to the `download page <http://readthedocs.org/projects/windpowerlib/downloads
26
26
Installation
27
27
============
28
28
29
-
If you have a working Python 3 environment, use pypi to install the latest windpowerlib version. We highly recommend to use virtual environments.
29
+
If you have a working Python 3 environment, use pypi to install the latest windpowerlib version:
30
30
31
31
::
32
32
33
33
pip install windpowerlib
34
34
35
-
The windpowerlib is designed for Python 3 and tested on Python >= 3.5.
35
+
The windpowerlib is designed for Python 3 and tested on Python >= 3.5. We highly recommend to use virtual environments.
36
36
Please see the `installation page <http://oemof.readthedocs.io/en/stable/installation_and_setup.html>`_ of the oemof documentation for complete instructions on how to install python and a virtual environment on your operating system.
37
37
38
-
For retrieving power (coefficient) curves from the OpenEnergy Database (oedb) the python package requests will be installed with your windpowerlib installation. The windpowerlib was tested with requests version 2.20.1 but might work with lower versions.
39
-
40
38
Optional Packages
41
39
~~~~~~~~~~~~~~~~~
42
40
43
41
To see the plots of the windpowerlib example in the `Examples and basic usage <http://windpowerlib.readthedocs.io/en/stable/getting_started.html#examplereference-label>`_ section you should `install the matplotlib package <http://matplotlib.org/users/installing.html>`_.
44
-
Matplotlib can be installed using pip3 though some Linux users reported that it is easier and more stable to use the pre-built packages of your Linux distribution.
42
+
Matplotlib can be installed using pip:
43
+
44
+
::
45
45
46
+
pip install matplotlib
46
47
47
48
.. _examplereference-label:
48
49
49
50
Examples and basic usage
50
51
=========================
51
52
52
-
The basic usage of the windpowerlib is shown in the `modelchain_example <http://windpowerlib.readthedocs.io/en/stable/modelchain_example_notebook.html>`_. The presented example is available as jupyter notebook and python script. You can download them along with example weather data:
53
+
The basic usage of the windpowerlib is shown in the `ModelChain example <http://windpowerlib.readthedocs.io/en/stable/modelchain_example_notebook.html>`_ that is available as jupyter notebook and python script:
53
54
54
55
* `ModelChain example (Python script) <https://raw.githubusercontent.com/wind-python/windpowerlib/master/example/modelchain_example.py>`_
55
56
* `ModelChain example (Jupyter notebook) <https://raw.githubusercontent.com/wind-python/windpowerlib/master/example/modelchain_example.ipynb>`_
56
-
* `Example data file <https://raw.githubusercontent.com/wind-python/windpowerlib/master/example/weather.csv>`_
57
57
58
-
To run the examples you first have to install the windpowerlib. To run the notebook you also need to install notebook using pip3. To launch jupyter notebook type ``jupyter notebook`` in terminal.
58
+
To run the example you need the example weather and turbine data used:
59
+
60
+
* `Example weather data file <https://raw.githubusercontent.com/wind-python/windpowerlib/master/example/weather.csv>`_
61
+
* `Example power curve data file <https://raw.githubusercontent.com/wind-python/windpowerlib/master/example/data/example_power_curves.csv>`_
62
+
* `Example power coefficient curve data file <https://raw.githubusercontent.com/wind-python/windpowerlib/master/example/data/example_power_coefficient_curves.csv>`_
63
+
* `Example nominal power data file <https://raw.githubusercontent.com/wind-python/windpowerlib/master/example/data/example_turbine_data.csv>`_
64
+
65
+
Furthermore, you have to install the windpowerlib. To run the notebook you also need to install `notebook` using pip3. To launch jupyter notebook type ``jupyter notebook`` in the terminal.
59
66
This will open a browser window. Navigate to the directory containing the notebook to open it. See the jupyter notebook quick start guide for more information on `how to install <http://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/install.html>`_ and
60
67
`how to run <http://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/execute.html>`_ jupyter notebooks.
61
68
62
-
Further functionalities, like the modelling of wind farms and wind turbine clusters, are shown in the `turbine_cluster_modelchain_example <http://windpowerlib.readthedocs.io/en/stable/turbine_cluster_modelchain_example_notebook.html>`_. As the ModelChain example it is available as jupyter notebook and as python script. The weather data in this example is the same as in the example above.
69
+
Further functionalities, like the modelling of wind farms and wind turbine clusters, are shown in the `TurbineClusterModelChain example <http://windpowerlib.readthedocs.io/en/stable/turbine_cluster_modelchain_example_notebook.html>`_. As the ModelChain example it is available as jupyter notebook and as python script. The weather and turbine datadata used in this example is the same as in the example above.
63
70
64
71
* `TurbineClusterModelChain example (Python script) <https://raw.githubusercontent.com/wind-python/windpowerlib/master/example/turbine_cluster_modelchain_example.py>`_
65
72
* `TurbineClusterModelChain example (Jupyter notebook) <https://raw.githubusercontent.com/wind-python/windpowerlib/master/example/turbine_cluster_modelchain_example.ipynb>`_
66
73
74
+
You can also look at the examples in the `Example <http://windpowerlib.readthedocs.io/en/stable/examples.html>`_ section.
75
+
76
+
Wind turbine data
77
+
==================
78
+
79
+
The windpowerlib provides `wind turbine data <https://github.com/wind-python/windpowerlib/tree/master/windpowerlib/oedb>`_
80
+
(power curves, hub heights, etc.) for a large set of wind turbines. Have a look at the `example <http://windpowerlib.readthedocs.io/en/stable/modelchain_example_notebook.html#Initialize-wind-turbine>`_ on how
81
+
to use this data in your simulations.
82
+
83
+
The dataset is hosted and maintained on the `OpenEnergy database <https://openenergy-platform.org/dataedit/>`_ (oedb).
84
+
To update your local files with the latest version of the `oedb turbine library <https://openenergy-platform.org/dataedit/view/supply/wind_turbine_library>`_ you can execute the following in your python console:
85
+
86
+
.. code:: python
87
+
88
+
from windpowerlib.wind_turbine import load_turbine_data_from_oedb
89
+
load_turbine_data_from_oedb()
90
+
91
+
We would like to encourage anyone to contribute to the turbine library by adding turbine data or reporting errors in the data.
92
+
See `here <https://github.com/OpenEnergyPlatform/data-preprocessing/issues/28>`_ for more information on how to contribute.
93
+
67
94
Contributing
68
95
==============
69
96
@@ -100,7 +127,6 @@ As the windpowerlib started with contributors from the `oemof developer group <h
100
127
101
128
pytest
102
129
103
-
104
130
Citing the windpowerlib
105
131
========================
106
132
@@ -109,7 +135,7 @@ We use the zenodo project to get a DOI for each version. `Search zenodo for the
109
135
License
110
136
============
111
137
112
-
Copyright (C) 2017 oemof developing group
138
+
Copyright (C) 2017 oemof developer group
113
139
114
140
This program is free software: you can redistribute it and/or modify
115
141
it under the terms of the GNU General Public License as published by
@@ -122,4 +148,4 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
122
148
GNU General Public License for more details.
123
149
124
150
You should have received a copy of the GNU General Public License
125
-
along with this program. If not, see http://www.gnu.org/licenses/.
151
+
along with this program. If not, see http://www.gnu.org/licenses/.
Copy file name to clipboardExpand all lines: doc/getting_started.rst
+35-10Lines changed: 35 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,46 +23,71 @@ Go to the `download page <http://readthedocs.org/projects/windpowerlib/downloads
23
23
Installation
24
24
============
25
25
26
-
If you have a working Python 3 environment, use pypi to install the latest windpowerlib version. We highly recommend to use virtual environments.
26
+
If you have a working Python 3 environment, use pypi to install the latest windpowerlib version:
27
27
28
28
::
29
29
30
30
pip install windpowerlib
31
31
32
-
The windpowerlib is designed for Python 3 and tested on Python >= 3.5.
32
+
The windpowerlib is designed for Python 3 and tested on Python >= 3.5. We highly recommend to use virtual environments.
33
33
Please see the `installation page <http://oemof.readthedocs.io/en/stable/installation_and_setup.html>`_ of the oemof documentation for complete instructions on how to install python and a virtual environment on your operating system.
34
34
35
-
For retrieving power (coefficient) curves from the OpenEnergy Database (oedb) the python package requests will be installed with your windpowerlib installation. The windpowerlib was tested with requests version 2.20.1 but might work with lower versions.
36
-
37
35
Optional Packages
38
36
~~~~~~~~~~~~~~~~~
39
37
40
38
To see the plots of the windpowerlib example in the :ref:`examplereference-label` section you should `install the matplotlib package <http://matplotlib.org/users/installing.html>`_.
41
-
Matplotlib can be installed using pip3 though some Linux users reported that it is easier and more stable to use the pre-built packages of your Linux distribution.
39
+
Matplotlib can be installed using pip:
40
+
41
+
::
42
42
43
+
pip install matplotlib
43
44
44
45
.. _examplereference-label:
45
46
46
47
Examples and basic usage
47
48
=========================
48
49
49
-
The basic usage of the windpowerlib is shown in the ModelChain example. The presented example is available as jupyter notebook and python script. You can download them along with example weather data:
50
+
The basic usage of the windpowerlib is shown in the ModelChain example that is available as jupyter notebook and python script:
50
51
51
52
* :download:`ModelChain example (Python script) <../example/modelchain_example.py>`
52
53
* :download:`ModelChain example (Jupyter notebook) <../example/modelchain_example.ipynb>`
53
-
* :download:`Example data file <../example/weather.csv>`
54
54
55
-
To run the examples you first have to install the windpowerlib. To run the notebook you also need to install notebook using pip3. To launch jupyter notebook type ``jupyter notebook`` in terminal.
55
+
To run the example you need the example weather and turbine data used:
56
+
57
+
* :download:`Example weather data file <../example/weather.csv>`
58
+
* :download:`Example power curve data file <../example/data/power_curves.csv>`
59
+
* :download:`Example power coefficient curve data file <../example/data/power_coefficient_curves.csv>`
60
+
* :download:`Example nominal power data file <../example/data/turbine_data.csv>`
61
+
62
+
Furthermore, you have to install the windpowerlib and to run the notebook you also need to install `notebook` using pip3. To launch jupyter notebook type ``jupyter notebook`` in the terminal.
56
63
This will open a browser window. Navigate to the directory containing the notebook to open it. See the jupyter notebook quick start guide for more information on `how to install <http://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/install.html>`_ and
57
64
`how to run <http://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/execute.html>`_ jupyter notebooks.
58
65
59
-
Further functionalities, like the modelling of wind farms and wind turbine clusters, are shown in the TurbineClusterModelChain example. As the ModelChain example it is available as jupyter notebook and as python script. The weather data in this example is the same as in the example above.
66
+
Further functionalities, like the modelling of wind farms and wind turbine clusters, are shown in the TurbineClusterModelChain example. As the ModelChain example it is available as jupyter notebook and as python script. The weather and turbine data in this example is the same as in the example above.
60
67
61
68
* :download:`TurbineClusterModelChain example (Python script) <../example/turbine_cluster_modelchain_example.py>`
62
69
* :download:`TurbineClusterModelChain example (Jupyter notebook) <../example/turbine_cluster_modelchain_example.ipynb>`
63
70
64
71
You can also look at the examples in the :ref:`examples_section_label` section.
65
72
73
+
Wind turbine data
74
+
==================
75
+
76
+
The windpowerlib provides `wind turbine data <https://github.com/wind-python/windpowerlib/tree/master/windpowerlib/oedb>`_
77
+
(power curves, hub heights, etc.) for a large set of wind turbines. See `Initialize wind turbine` in :ref:`examples_section_label` on how
78
+
to use this data in your simulations.
79
+
80
+
The dataset is hosted and maintained on the `OpenEnergy database <https://openenergy-platform.org/dataedit/>`_ (oedb).
81
+
To update your local files with the latest version of the `oedb turbine library <https://openenergy-platform.org/dataedit/view/supply/wind_turbine_library>`_ you can execute the following in your python console:
82
+
83
+
.. code:: python
84
+
85
+
from windpowerlib.wind_turbine import load_turbine_data_from_oedb
86
+
load_turbine_data_from_oedb()
87
+
88
+
We would like to encourage anyone to contribute to the turbine library by adding turbine data or reporting errors in the data.
89
+
See `here <https://github.com/OpenEnergyPlatform/data-preprocessing/issues/28v>`_ for more information on how to contribute.
90
+
66
91
Contributing
67
92
==============
68
93
@@ -107,7 +132,7 @@ We use the zenodo project to get a DOI for each version. `Search zenodo for the
107
132
License
108
133
============
109
134
110
-
Copyright (C) 2017 oemof developing group
135
+
Copyright (C) 2017 oemof developer group
111
136
112
137
This program is free software: you can redistribute it and/or modify
113
138
it under the terms of the GNU General Public License as published by
* 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.
* 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.
17
+
* 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.
18
+
* 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.
19
+
* 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'.
20
+
* Removed `overwrite` parameter from :py:func:`~.wind_turbine.get_turbine_data_from_oedb`
21
+
22
+
Other changes
23
+
#############
24
+
* Power curves and nominal power of wind turbines are now saved in file in W instead of kW to be consistent with internal units.
25
+
* Restructured csv reading for offline usage of windpowerlib. The nominal power of wind turbines is now saved to a separate file along with other turbine data from the oedb turbine library.
26
+
* get_turbine_types() can now be used to get provided turbine types of oedb turbine library as well as provided turbine types of local files.
27
+
28
+
Documentation
29
+
#############
30
+
* Improved documentation of :class:`~windpowerlib.modelchain.ModelChain` and :class:`~windpowerlib.turbine_cluster_modelchain.TurbineClusterModelChain` parameters (`PR 64 <https://github.com/wind-python/windpowerlib/pull/64>`_).
31
+
* Added info in README and getting started section on how to contribute to the oedb wind turbine library.
0 commit comments