Commit dcb36b28 authored by Adam Fekete's avatar Adam Fekete
Browse files

Update README.md

parent b170f61a
# Single-user Jupyter notebook image for workshops
**Please note that this documentation is just a draft. Some of the instructions may be incomplete.**
# Jupyter notebook image for workshops
This notebook folder contains Dockerfile for a single user notebook image which based on Jupyter docker stack.
In addition to the base notebook, it contains all of the necessary packages for the tools.
The docker image is suitable for running/testing locally and for deploying it by the jupyterhub on a kubernetes cluster.
## Short description
## Quickstart (without cloning the repository)
- Based on the jupyter docker image
- Compiled abinit
- Conda python environments
```bash
mkdir workshop
cd workshop
wget https://gitlab.mpcdf.mpg.de/nomad-lab/workflows-workshop/-/raw/master/docker-compose.yml
docker-compose up
```
## Building/using your own docker image
```bash
git clone https://github.com/modl-uclouvain/workflows-workshop.git
git clone https://gitlab.mpcdf.mpg.de/nomad-lab/workflows-workshop.git
cd workflows-workshop
```
......@@ -98,16 +99,16 @@ Each commit triggers a build process on GitLab Runner. Besides the latest tag, t
```
3. Pull the image:
```bash
docker pull gitlab-registry.mpcdf.mpg.de/nomad-lab/analytics-workshop:<tag>
docker pull gitlab-registry.mpcdf.mpg.de/nomad-lab/workflows-workshop:<tag>
```
4. Create a container:
```bash
docker run -p 8888:8888 \
-v $PWD/notebook/tutorials:/home/jovyan/tutorials \
gitlab-registry.mpcdf.mpg.de/nomad-lab/analytics-workshop:<tag>
gitlab-registry.mpcdf.mpg.de/nomad-lab/workflows-workshop:<tag>
```
Note: The latest tag can be found on the following page:
https://gitlab.mpcdf.mpg.de/nomad-lab/analytics-workshop/container_registry
https://gitlab.mpcdf.mpg.de/nomad-lab/workflows-workshop/container_registry
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment