Skip to content

Commit 01da9ac

Browse files
Birgit SchachlerBirgit Schachler
authored andcommitted
Seperate README and getting started files due to links in README
1 parent 0ff5a95 commit 01da9ac

File tree

2 files changed

+87
-7
lines changed

2 files changed

+87
-7
lines changed

README.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Introduction
44
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
55
`feedinlib <https://github.com/oemof/feedinlib>`_ (windpower and pv) but was taken out to build up a community concentrating on wind power models.
66

7-
For a quick start see the :ref:`examplereference-label` section.
7+
For a quick start see the `'Examples and basic usage' <http://windpowerlib.readthedocs.io/en/latest/getting_started.html#examplereference-label>`_ section.
88

99

1010
Documentation
@@ -31,7 +31,7 @@ Please see the `installation page <http://oemof.readthedocs.io/en/stable/install
3131
Optional Packages
3232
~~~~~~~~~~~~~~~~~
3333

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>`_.
34+
To see the plots of the windpowerlib example in the `'Examples and basic usage' <http://windpowerlib.readthedocs.io/en/latest/getting_started.html#examplereference-label>`_ section you should `install the matplotlib package <http://matplotlib.org/users/installing.html>`_.
3535
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.
3636

3737

@@ -40,11 +40,12 @@ Matplotlib can be installed using pip3 though some Linux users reported that it
4040
Examples and basic usage
4141
=========================
4242

43-
The basic usage of the windpowerlib is shown :ref:`here <basic_example_notebook.ipynb>`. The presented example is available as jupyter notebook and python script. You can download them along with example weather data:
43+
The basic usage of the windpowerlib is shown `'here' <http://windpowerlib.readthedocs.io/en/latest/basic_example_notebook.html>`_. The presented example is available as jupyter notebook and python script. You can download them along with example weather data:
44+
45+
* `'Python script' <https://raw.githubusercontent.com/wind-python/windpowerlib/dev/example/basic_example.py>`_
46+
* `'Jupyter notebook' <https://raw.githubusercontent.com/wind-python/windpowerlib/features/revise_example/example/basic_example.ipynb>`_
47+
* `'Example data file' <https://raw.githubusercontent.com/wind-python/windpowerlib/dev/example/weather.csv>`_
4448

45-
* :download:`Python script <../example/basic_example.py>`
46-
* :download:`Jupyter notebook <../example/basic_example.ipynb>`
47-
* :download:`Example data file <../example/weather.csv>`
4849

4950
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.
5051
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

doc/getting_started.rst

Lines changed: 80 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,83 @@
22
Getting started
33
~~~~~~~~~~~~~~~~~~~~~~
44

5-
.. include:: ../README.rst
5+
Introduction
6+
=============
7+
8+
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
9+
`feedinlib <https://github.com/oemof/feedinlib>`_ (windpower and pv) but was taken out to build up a community concentrating on wind power models.
10+
11+
For a quick start see the :ref:`examplereference-label` section.
12+
13+
14+
Documentation
15+
==============
16+
17+
Full documentation can be found at `readthedocs <http://windpowerlib.readthedocs.org>`_.
18+
19+
Use the `project site <http://readthedocs.org/projects/windpowerlib>`_ of readthedocs to choose the version of the documentation.
20+
Go to the `download page <http://readthedocs.org/projects/windpowerlib/downloads/>`_ to download different versions and formats (pdf, html, epub) of the documentation.
21+
22+
23+
Installation
24+
============
25+
26+
If you have a working Python3 environment, use pypi to install the latest windpowerlib version.
27+
28+
::
29+
30+
pip3 install windpowerlib
31+
32+
So far, the windpowerlib is mainly tested on python 3.4 but seems to work down to 2.7.
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 on your operating system.
34+
35+
Optional Packages
36+
~~~~~~~~~~~~~~~~~
37+
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>`_.
39+
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.
40+
41+
42+
.. _examplereference-label:
43+
44+
Examples and basic usage
45+
=========================
46+
47+
The basic usage of the windpowerlib is shown :ref:`here <basic_example_notebook.ipynb>`. The presented example is available as jupyter notebook and python script. You can download them along with example weather data:
48+
49+
* :download:`Python script <../example/basic_example.py>`
50+
* :download:`Jupyter notebook <../example/basic_example.ipynb>`
51+
* :download:`Example data file <../example/weather.csv>`
52+
53+
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.
54+
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
55+
`how to run <http://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/execute.html>`_ jupyter notebooks.
56+
57+
58+
Contributing
59+
==============
60+
61+
Clone/Fork: https://github.com/wind-python/windpowerlib
62+
63+
If you are interested in wind models and want to help improve the existing model do not hesitate to contact us.
64+
As the windpowerlib started with contributors from the `oemof developer group <https://github.com/orgs/oemof/teams/oemof-developer-group>`_ we use the same
65+
`developer rules <http://oemof.readthedocs.io/en/stable/developing_oemof.html>`_.
66+
67+
68+
License
69+
============
70+
71+
Copyright (C) 2017 oemof developing group
72+
73+
This program is free software: you can redistribute it and/or modify
74+
it under the terms of the GNU General Public License as published by
75+
the Free Software Foundation, either version 3 of the License, or
76+
(at your option) any later version.
77+
78+
This program is distributed in the hope that it will be useful,
79+
but WITHOUT ANY WARRANTY; without even the implied warranty of
80+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
81+
GNU General Public License for more details.
82+
83+
You should have received a copy of the GNU General Public License
84+
along with this program. If not, see http://www.gnu.org/licenses/.

0 commit comments

Comments
 (0)