Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add overview README file for notebooks #2416

Merged
merged 5 commits into from
Jun 7, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
neteler marked this conversation as resolved.
Show resolved Hide resolved
server from the command line in the `doc/notebooks/` directory containing the `*.jpynb` files with:
neteler marked this conversation as resolved.
Show resolved Hide resolved
`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 `*.jpynb` files will start the notebook.
neteler marked this conversation as resolved.
Show resolved Hide resolved

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](grass.jupyter: temporal.ipynb)
neteler marked this conversation as resolved.
Show resolved Hide resolved
- 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)