Skip to content

Commit 0ff5a95

Browse files
Birgit SchachlerBirgit Schachler
authored andcommitted
Add content to section Examples and basic usage
1 parent 354519e commit 0ff5a95

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,17 @@ 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:
44+
45+
* :download:`Python script <../example/basic_example.py>`
46+
* :download:`Jupyter notebook <../example/basic_example.ipynb>`
47+
* :download:`Example data file <../example/weather.csv>`
48+
49+
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.
50+
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
51+
`how to run <http://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/execute.html>`_ jupyter notebooks.
52+
53+
4354
Contributing
4455
==============
4556

0 commit comments

Comments
 (0)