Skip to content

Commit

Permalink
doc/notebooks: add overview README.md (#2416)
Browse files Browse the repository at this point in the history
* doc/notebooks: add overview README.md

This README.md lists all Jupyter notebooks with their respective titles.
Additionally it is explained how to actually start a Jupyter notebook.

Co-authored-by: Veronica Andreo <veroandreo@gmail.com>
  • Loading branch information
neteler and veroandreo committed Oct 17, 2022
1 parent fe65aa8 commit 8f5cb11
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions doc/notebooks/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Introduction

### Using the notebooks locally

Clone this repository with `git clone` first. Then, locally start the Jupyter notebook
server from the command line in the `doc/notebooks/` directory containing the `*.ipynb` files with:
`jupyter notebook`

This will open a new browser tab or window with a list of the contents of the current
working directory. Clicking on one of the `*.ipynb` files will start the notebook.

See also the official documentation for [The Jupyter Notebook](https://jupyter-notebook.readthedocs.io/en/latest/).

### Introductory notebooks to GRASS GIS and Jupyter

- GRASS GIS in Jupyter Notebook with Python and grass.jupyter: [jupyter_example.ipynb](jupyter_example.ipynb)
- The grass.jupyter Package: [jupyter_tutorial.ipynb](jupyter_tutorial.ipynb)

## Thematic Jupyter notebooks:

- Viewshed Analysis: [viewshed_analysis.ipynb](viewshed_analysis.ipynb)
- Spatio-Temporal Analysis with grass.jupyter: [temporal.ipynb](temporal.ipynb)
- Solar Energy Potential Analysis: [solar_potential.ipynb](solar_potential.ipynb)
- GRASS GIS Scripting with Python: [scripting_example.ipynb](scripting_example.ipynb)
- Hydrology with GRASS GIS: [hydrology.ipynb](hydrology.ipynb)

0 comments on commit 8f5cb11

Please sign in to comment.