From 0f471be88e2b634017935e57d46a4007e3f79797 Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Fri, 5 Feb 2021 15:01:52 +0100 Subject: [PATCH] Adjust README and Dockerfile to bring in more packages --- Dockerfile | 19 ++++++++++++++++++- README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 62 insertions(+), 2 deletions(-) diff --git a/Dockerfile b/Dockerfile index fde78b3..b1009d0 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,21 @@ -FROM jupyter/base-notebook +# Copyright (c) Earthobservations Development Team. +# Distributed under the terms of the MIT License. + +ARG BASE_CONTAINER=scioquiver/notebooks:cgspatial-notebook +FROM $BASE_CONTAINER + +LABEL maintainer="Earthobservations Developers " + +RUN pip install \ + luftdatenpumpe \ + phenodata \ + wetterdienst \ + wradlib + +USER $NB_USER + +WORKDIR $HOME + # Add RUN statements to install packages as the $NB_USER defined in the base images. diff --git a/README.md b/README.md index 7f81b68..2430d26 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,46 @@ # earthobservations-notebook -earthobservations-notebook is a community maintained Jupyter Docker Stack image \ No newline at end of file +## About +`earthobservations-notebook` is a community Jupyter Docker Stack image. + +The image includes some gems on top of the [cgspatial-notebook] image, which is +in turn based on the [datascience-notebook] and the [scipy-notebook] images. + + +## Bootstrapping phase +- We are following the guidelines at [Jupyter Community Stacks]. +- It is a new notebook and actively looking for contributors. +- Our mission is _standing on the shoulder of giants_ without _reinventing the wheel_. + + +## Build +The image is not yet available on any container registry. So, we have to build +it beforehand. +```sh +docker build --tag=earthobservations/earthobservations-notebook . +``` + + +## Run +Invoke an _ephemeral_ container running a Jupyter Notebook server and expose it +on port 8888. +```sh +docker run -it --rm --publish=8888:8888 earthobservations/earthobservations-notebook +``` +The server logs will appear in the terminal. Visiting +`http://:8888/?token=` in a browser loads JupyterLab, where +`hostname` is the name of the computer running docker and `token` is the secret +token printed in the console. Docker destroys the container after notebook +server exit. + + +## Credits +Kudos go to all people from the community for tirelessly working on the +foundation infrastructure. You know who you are. + + + +[Jupyter Community Stacks]: https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/stacks.html +[cgspatial-notebook]: https://github.com/SCiO-systems/cgspatial-notebook +[datascience-notebook]: https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html#jupyter-datascience-notebook +[scipy-notebook]: https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html#jupyter-scipy-notebook