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
+26-32Lines changed: 26 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,36 +1,19 @@
1
-
windpowerlib
2
-
==============
3
-
4
-
The windpowerlib is designed to calculate feedin time series of wind power plants. The windpowerlib is an out-take from the
5
-
`feedinlib <https://github.com/oemof/feedinlib>`_ (windpower and pv) to build up a community concentrating on wind power models.
6
-
7
-
.. contents:: `Table of contents`
8
-
:depth: 1
9
-
:local:
10
-
:backlinks: top
11
-
12
1
Introduction
13
-
============
14
-
15
-
Having weather data sets you can use the windpowerlib to calculate the electrical output of common wind turbines.
16
-
Basic parameters for many manufacturers are provided with the library so that you can start directly using one of these parameter sets. Of course you are free to add your own parameter set.
17
-
For a quick start download the example weather data and basic example file and execute it:
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
5
+
`feedinlib <https://github.com/oemof/feedinlib>`_ (windpower and pv) but was taken out to build up a community concentrating on wind power models.
20
6
21
-
Documentation
22
-
==============
7
+
For a quick start see the :ref:`examplereference-label` section.
23
8
24
-
Full documentation can be found at `readthedocs <http://windpowerlib.readthedocs.org/en/latest/>`_. Use the project site of readthedocs to choose the version of the documentation.
Full documentation can be found at `readthedocs <http://windpowerlib.readthedocs.org>`_.
30
14
31
-
If you are interested in wind models and want to help improve the existing model do not hesitate to contact us.
32
-
As the windpowerlib started with contributors from the `oemof developer group <https://github.com/orgs/oemof/teams/oemof-developer-group>`_ we use the same
Use the `project site <http://readthedocs.org/projects/windpowerlib>`_ of readthedocs to choose the version of the documentation.
16
+
Go to the `download page <http://readthedocs.org/projects/windpowerlib/downloads/>`_ to download different versions and formats (pdf, html, epub) of the documentation.
34
17
35
18
36
19
Installation
@@ -40,20 +23,31 @@ If you have a working Python3 environment, use pypi to install the latest windpo
40
23
41
24
::
42
25
43
-
pip install windpowerlib
26
+
pip3 install windpowerlib
44
27
45
-
So far, the windpowerlib is mainly tested on python 3.4 but seems to work down to 2.7
46
-
and for newer versions. 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 on your operating system.
28
+
So far, the windpowerlib is mainly tested on python 3.4 but seems to work down to 2.7.
29
+
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 on your operating system.
47
30
48
-
49
31
Optional Packages
50
32
~~~~~~~~~~~~~~~~~
51
33
52
-
To see the plots of the example file you should install the matplotlib package.
34
+
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>`_.
35
+
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.
36
+
37
+
38
+
.. _examplereference-label:
39
+
40
+
Examples and basic usage
41
+
=========================
42
+
43
+
Contributing
44
+
==============
53
45
54
-
Matplotlib can be installed using pip3 but some Linux users reported that it is easier and more stable to use the pre-built packages of your Linux distribution.
If you are interested in wind models and want to help improve the existing model do not hesitate to contact us.
49
+
As the windpowerlib started with contributors from the `oemof developer group <https://github.com/orgs/oemof/teams/oemof-developer-group>`_ we use the same
0 commit comments