Skip to content

Latest commit

 

History

History
83 lines (60 loc) · 3.25 KB

README.md

File metadata and controls

83 lines (60 loc) · 3.25 KB
Raw

Docker Pangeo Machine Learning Notebook for Galaxy

This Jupyter Docker container is used by the Galaxy Project.

It is based on Pangeo ml-notebook docker image.

docker pull quay.io/nordicesmhub/docker-pangeo-ml-notebook

Usage

  • Build your own image and run it

Docker is a pre-requirement for this project. You can build the container with:

 docker build -t docker-pangeo-ml-notebook .

The build process can take some time, but if finished you can run your container with:

 docker run -p 7777:8888 -i -t docker-pangeo-ml-notebook

and you will have a running Jupyter Notebook instance on http://localhost:7777/ipython/.

  • Run a pre-build image from docker registry

docker run -p 7777:8888 quay.io/nordicesmhub/docker-pangeo-ml-notebook

  • If you wish to run jupyterlab

docker run -it --rm --volume $WORKDIR:$HOME -p 7777:8888 quay.io/nordicesmhub/docker-pangeo-notebook:2023.02.27 jupyter lab --ip 0.0.0.0 $WORKDIR

where $WORKDIR is an environment variable pointing to the path of your choice.

Environment Variables

Some environment variables are made available to the user which will allow for configuring the behaviour of individual instances.

Variable Use
API_KEY Galaxy API Key with which to interface with Galaxy
CORS_ORIGIN If the notebook is proxied, this is the URL the end-user will see when trying to access a notebook
DEBUG Enable debugging mode, mostly for developers
GALAXY_URL URL at which Galaxy is accessible
GALAXY_WEB_PORT Port on which Galaxy is running, if applicable
HISTORY_ID ID of current Galaxy History, used in easing the dataset upload/download process
NOTEBOOK_PASSWORD Password with which to secure the notebook
PROXY_PREFIX Prefix to URL which allows Galaxy proxy to share cookies with Galaxy itself.

Authors

  • Bjoern Gruening
  • Eric Rasche
  • Anne Fouilloux

Licence (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.