View source for GRASS GIS Jupyter notebooks

A Jupyter Notebook is a web application that allows you to create and share documents that contain scripts and code, equations, visualizations and explanatory text, combined.

You can even change the code and explore your modified script(s).

== How to run GRASS GIS from Jupyter notebook ==

Running GRASS from Jupyter notebook requires that Jupyter notebook is installed on your system, and that you set up the [https://grass.osgeo.org/grass72/manuals/variables.html environment variables] for using GRASS. For example you can create a script called grass_jupyter.sh that contains the following lines:

<source lang="bash">

# directory where GRASS lives
export GISBASE=/usr/local/grass-7.3.svn # Change this path to reflect your own

# generate GISRC
# Defines the system wide value while in a GRASS session
MYGISDBASE=$HOME/grassdata # Change this path to reflect your own 
MYLOC=MyLoc # Change this location name to reflect your own 
MYMAPSET=PERMANENT

# Set the global grassrc file to individual file name
MYGISRC="$HOME/.grassrc.$$"

echo "GISDBASE: $MYGISDBASE" > "$MYGISRC"
echo "LOCATION_NAME: $MYLOC" >> "$MYGISRC"
echo "MAPSET: $MYMAPSET" >> "$MYGISRC"
echo "GRASS_GUI: text" >> "$MYGISRC"

# path to GRASS settings file
export GISRC=$MYGISRC

export LD_LIBRARY_PATH=$GISBASE/lib:$LD_LIBRARY_PATH
export PYTHONPATH=$GISBASE/etc/python:$PYTHONPATH
export PATH=$GISBASE/bin:$GISBASE/scripts:$PATH

# start the notebook in the notebook folder
cd $HOME/notebooks # change this path to reflect your own path to notebooks folder

nohup jupyter notebook --ip=0.0.0.0 --port=8888 --debug &

</source>

Add this line to your $HOME/.bashrc file:

<source lang="bash">
alias grass_notebook='sh grass_jupyter.sh'
</source>

From terminal, in your home directory:
<source lang="bash">
source .bashrc
</source>

Now you can start your notebook typing in the terminal:
<source lang="bash">
grass_notebook
</source>

=== List of selected GRASS GIS Jupyter notebooks ===

(please expand!)

* OSGeoLive-Notebooks: [https://github.com/OSGeo/OSGeoLive-Notebooks/tree/master/GSoC-2015/Introduction%20to%20GRASS%20GIS Introduction to GRASS GIS]
* [https://github.com/zarch/workshop-pygrass Workshop on pygrass using IPython notebook]
* [https://github.com/tgrippa/Opensource_OBIA_processing_chain An open-source semi-automated processing chain for urban OBIA classification]
* [https://github.com/wenzeslaus/python-grass-addon How to write a Python GRASS GIS 7 addon]
* [https://github.com/lucadelu/docker-stacks/tree/geospatial/geospatial-notebook docker-stacks/geospatial-notebook]
* [https://github.com/wenzeslaus/geospatial-modeling-course-jupyter/tree/master/notebooks 14 Jupyter Notebooks for learning geospatial analysis and modeling with GRASS GIS]
* [https://gist.github.com/joergsteinkamp/43fb13a82aeab9b5c0dcc4433f97f1a6 Simple Opensource GIS examples with Grass and R]

==== See also ====

* [https://github.com/wenzeslaus/gdoc2py GRASS GIS focused converter from HTML with pre code tags to Jupyter Notebook]

[[Category: Documentation]]
[[Category: Python]]
[[Category: Tutorial]]