Jupyter Notebooks are documents which can contain live (Python) code, equations, visualizations and narrative text and can be used as an intuitive interface for OGS projects. The following video gives an introduction to using OpenGeoSys with Jupyter Notebooks:
You can use a pre-defined container environment which currently contains:
With Docker:
docker run --rm -p 8888:8888 -v $PWD:/home/jovyan/work --user `id -u $USER` \
--group-add users registry.opengeosys.org/ogs/ogs/ogs-serial-jupyter
This mounts your current directory into ~/work
inside the container.
The above command only works when you run Docker from within a WSL2 Linux shell!
$PWD
, e.g.:... -v /c/Users/My\ Name/working/directory:/home/jovyan/work ...
With Singularity:
singularity run docker://registry.opengeosys.org/ogs/ogs/ogs-serial-jupyter
Open the specified URL shown in the command output in your browser, e.g.
http://127.0.0.1:8888/lab?token=xxx
You may have to modify the IP address if this is running on a remote machine.
In a running container you can install additional Python packages with the Jupyter magic command %pip
:
%pip install [package name]
Please note that this is a temporary installation. If you stop the container the environment is destroyed.
When using PyVista the container uses the (interactive) pythreejs rendering backend per default. If you want to output static images there are a couple of ways to configure the ‘static’ rendering backend:
PYVISTA_JUPYTER_BACKEND=static
. This can be defined when starting the container:
docker run ... -e PYVISTA_JUPYTER_BACKEND=static ...
import pyvista as pv
pv.set_jupyter_backend('static')
import pyvista as pv
...
pv.show(jupyter_backend='static')
This article was written by Lars Bilke. If you are missing something or you find an error please let us know.
Generated with Hugo 0.79.0. Last revision: September 22, 2021
Commit: [web] Added notes on Windows usage. a43d5ee
| Edit this page on