Skip to content

Commit c2d3880

Browse files
committed
Add further_example to documentation
1 parent ba673fc commit c2d3880

File tree

5 files changed

+388
-3
lines changed

5 files changed

+388
-3
lines changed

README.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,11 @@ To run the examples you first have to install the windpowerlib. To run the noteb
5151
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
5252
`how to run <http://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/execute.html>`_ jupyter notebooks.
5353

54+
Further functionalities are shown in a second example. As the basic usage example it is available as jupyter notebook and as python script. The weather data in this example is the same as in the example above.
55+
56+
* :download:`Further example (Python script) <../example/further_example.py>`
57+
* :download:`Further example (Jupyter notebook) <../example/further_example.ipynb>`
58+
* :download:`Example data file <../example/weather.csv>`
5459

5560
Contributing
5661
==============

doc/examples_basic_and_further.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#############
2+
Examples
3+
#############
4+
5+
6+
.. toctree::
7+
8+
basic_example_notebook
9+
further_example_notebook

doc/further_example_notebook.ipynb

Lines changed: 356 additions & 0 deletions
Large diffs are not rendered by default.

doc/getting_started.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,19 @@ Examples and basic usage
4646

4747
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:
4848

49-
* :download:`Python script <../example/basic_example.py>`
50-
* :download:`Jupyter notebook <../example/basic_example.ipynb>`
49+
* :download:`Basic example (Python script) <../example/basic_example.py>`
50+
* :download:`Basic example (Jupyter notebook) <../example/basic_example.ipynb>`
5151
* :download:`Example data file <../example/weather.csv>`
5252

5353
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.
5454
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
5555
`how to run <http://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/execute.html>`_ jupyter notebooks.
5656

57+
Further functionalities are shown in a second example. As the basic usage example it is available as jupyter notebook and as python script. The weather data in this example is the same as in the example above.
58+
59+
* :download:`Further example (Python script) <../example/further_example.py>`
60+
* :download:`Further example (Jupyter notebook) <../example/further_example.ipynb>`
61+
* :download:`Example data file <../example/weather.csv>`
5762

5863
Contributing
5964
==============

doc/index.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,17 @@ Contents:
88
:glob:
99

1010
getting_started
11-
basic_example_notebook
11+
12+
.. toctree::
13+
:maxdepth: 3
14+
:glob:
15+
16+
examples_basic_and_further
17+
18+
.. toctree::
19+
:maxdepth: 2
20+
:glob:
21+
1222
whats_new
1323
modules
1424

0 commit comments

Comments
 (0)