Skip to content

Commit 354519e

Browse files
Birgit SchachlerBirgit Schachler
authored andcommitted
Restructure README and add some information
1 parent 618d332 commit 354519e

File tree

1 file changed

+26
-32
lines changed

1 file changed

+26
-32
lines changed

README.rst

Lines changed: 26 additions & 32 deletions
Original file line numberDiff line numberDiff 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-
121
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:
2+
=============
183

19-
https://github.com/wind-python/windpowerlib/tree/master/example
4+
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.
206

21-
Documentation
22-
==============
7+
For a quick start see the :ref:`examplereference-label` section.
238

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.
259

26-
Contributing
10+
Documentation
2711
==============
2812

29-
Clone/Fork: https://github.com/wind-python/windpowerlib
13+
Full documentation can be found at `readthedocs <http://windpowerlib.readthedocs.org>`_.
3014

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
33-
`developer rules <http://oemof.readthedocs.io/en/stable/developing_oemof.html>`_.
15+
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.
3417

3518

3619
Installation
@@ -40,20 +23,31 @@ If you have a working Python3 environment, use pypi to install the latest windpo
4023

4124
::
4225

43-
pip install windpowerlib
26+
pip3 install windpowerlib
4427

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.
4730

48-
4931
Optional Packages
5032
~~~~~~~~~~~~~~~~~
5133

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+
==============
5345

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.
46+
Clone/Fork: https://github.com/wind-python/windpowerlib
5547

56-
http://matplotlib.org/users/installing.html
48+
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
50+
`developer rules <http://oemof.readthedocs.io/en/stable/developing_oemof.html>`_.
5751

5852

5953
License

0 commit comments

Comments
 (0)