Skip to content

Commit b659ce6

Browse files
Birgit SchachlerBirgit Schachler
authored andcommitted
Adapt documentation
1 parent 04a28a4 commit b659ce6

File tree

2 files changed

+23
-45
lines changed

2 files changed

+23
-45
lines changed

README.rst

Lines changed: 19 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
The windpowerlib is designed to calculate feedin time series of wind power plants. The windpowerlib is an out-take from the feedinlib (windpower and pv) to build up a community concentrating on wind power models.
1+
windpowerlib
2+
==============
23

3-
The windpowerlib is ready to use but may have some teething troubles. The used model is still very simple but we found some new contributors and the windpowerlib will improve soon. If you are interested in wind models and want to improve the existing model, publish an alternative model or extend it to wind farms do not hesitate to contact us.
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.
46

57
.. contents:: `Table of contents`
68
:depth: 1
@@ -10,67 +12,44 @@ The windpowerlib is ready to use but may have some teething troubles. The used m
1012
Introduction
1113
============
1214

13-
Having weather data sets you can use the windpowerlib to calculate the electrical output of common wind power plants. 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.
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:
1418

15-
The cp-values for the wind turbines are provided by the Reiner Lemoine Institut and can be found here:
19+
https://github.com/wind-python/windpowerlib/tree/master/example
1620

17-
* http://vernetzen.uni-flensburg.de/~git/cp_values.csv
21+
Documentation
22+
==============
1823

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

20-
Actual Release
21-
~~~~~~~~~~~~~~
22-
23-
Download/Install: https://pypi.python.org/pypi/windpowerlib/
24-
25-
Documentation: http://pythonhosted.org/windpowerlib/
26-
27-
Developing Version
28-
~~~~~~~~~~~~~~~~~~
26+
Contributing
27+
==============
2928

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

32-
Documentation: http://windpowerlib.readthedocs.org/en/latest/
33-
34-
As the windpowerlib started with contributors from the oemof developer group we use the same developer rules: http://oemof.readthedocs.io/en/stable/developer_notes.html
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>`_.
3534

3635

3736
Installation
3837
============
3938

40-
Using the windpowerlib
41-
~~~~~~~~~~~~~~~~~~~~~~~
42-
43-
So far, the windpowerlib is mainly tested on python 3.4 but seems to work down
44-
to 2.7.
45-
4639
Install the windpowerlib using pip3.
4740

4841
::
4942

5043
pip3 install windpowerlib
5144

52-
Developing the Windpowerlib
53-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54-
55-
If you have push rights clone this repository to your local system.
56-
57-
::
58-
59-
git clone [email protected]:oemof/windpower.git
60-
61-
If you do not have push rights, fork the project at github, clone your personal fork to your system and send a pull request.
62-
63-
If the project is cloned you can install it using pip3 with the -e flag. Using this installation, every change is applied directly.
64-
65-
::
45+
So far, the windpowerlib is mainly tested on python 3.4 but seems to work down to 2.7.
46+
Please see the `Installation page <http://oemof.readthedocs.io/en/stable/installation_and_setup.html>`_ of the documentation for complete instructions.
6647

67-
pip3 install -e <path/to/the/windpowerlib/root/dir>
68-
6948

7049
Optional Packages
7150
~~~~~~~~~~~~~~~~~
7251

73-
To see the plots of the example file one should install the matplotlib package.
52+
To see the plots of the example file you should install the matplotlib package.
7453

7554
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.
7655

doc/modules.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ power curve or power coefficient curve needed by the :py:class:`~wind_turbine.Wi
4747
.. autosummary::
4848
:toctree: temp/
4949

50-
wind_turbine.WindTurbine.fetch_wpp_data
51-
wind_turbine.get_wind_pp_types
52-
wind_turbine.read_wpp_data
50+
wind_turbine.WindTurbine.fetch_turbine_data
51+
wind_turbine.get_turbine_types
52+
wind_turbine.read_turbine_data
5353

5454

5555
Power output
@@ -90,5 +90,4 @@ Methods of the Modelchain object.
9090

9191
modelchain.Modelchain.rho_hub
9292
modelchain.Modelchain.v_wind_hub
93-
modelchain.Modelchain.turbine_power_output
94-
modelchain.Modelchain.read_weather_data
93+
modelchain.Modelchain.turbine_power_output

0 commit comments

Comments
 (0)