Getting started¶

Introduction¶

The windpowerlib is a library that provides a set of functions and classes to calculate the power output of wind turbines. It was originally part of the feedinlib (windpower and pv) but was taken out to build up a community concentrating on wind power models.

For a quick start see the Examples and basic usage section.

Documentation¶

Full documentation can be found at readthedocs.

Use the project site of readthedocs to choose the version of the documentation. Go to the download page to download different versions and formats (pdf, html, epub) of the documentation.

Installation¶

If you have a working Python3 environment, use pypi to install the latest windpowerlib version.

pip3 install windpowerlib

So far, the windpowerlib is mainly tested on python 3.4 but seems to work down to 2.7. Please see the installation page of the oemof documentation for complete instructions on how to install python on your operating system.

Optional Packages¶

To see the plots of the windpowerlib example in the Examples and basic usage section you should install the matplotlib package. 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.

Examples and basic usage¶

The basic usage of the windpowerlib is shown here. The presented example is available as jupyter notebook and python script. You can download them along with example weather data:

Python script

Jupyter notebook

Example data file

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. 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 and how to run jupyter notebooks.

Contributing¶

Clone/Fork: https://github.com/wind-python/windpowerlib

If you are interested in wind models and want to help improve the existing model do not hesitate to contact us. As the windpowerlib started with contributors from the oemof developer group we use the same developer rules.

License¶

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.