diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 1d16d2e5ccacc3cbc4781762345016c59bf2d6e7..3f4ed348bbee139ff1d76fd8c5f8bea3b608b14b 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -38,9 +38,9 @@ build-binder: - ls - apk update && apk add curl - chmod +x binder/trigger-binder.sh - - binder/trigger-binder.sh https://mybinder.org/build/git/https%3A%2F%2Fgit.rwth-aachen.de%2FIENT%2Fjupyter-quickstart/master - - binder/trigger-binder.sh https://gke.mybinder.org/build/git/https%3A%2F%2Fgit.rwth-aachen.de%2FIENT%2Fjupyter-quickstart/master - - binder/trigger-binder.sh https://ovh.mybinder.org/build/git/https%3A%2F%2Fgit.rwth-aachen.de%2FIENT%2Fjupyter-quickstart/master + - binder/trigger-binder.sh https://mybinder.org/build/git/https%3A%2F%2Fgit-ce.rwth-aachen.de%2Fjupyter%2Fexample-profile/master + - binder/trigger-binder.sh https://gke.mybinder.org/build/git/https%3A%2F%2Fgit-ce.rwth-aachen.de%2Fjupyter%2Fexample-profile/master + - binder/trigger-binder.sh https://ovh.mybinder.org/build/git/https%3A%2F%2Fgit-ce.rwth-aachen.de%2Fjupyter%2Fexample-profile/master - ls only: - master diff --git a/Dockerfile b/Dockerfile index ca619abf1b99cf796ce51dc0846d85afa2835f55..b6757776a0ce1204b74e1b66e0947c0b5a9aa742 100644 --- a/Dockerfile +++ b/Dockerfile @@ -5,7 +5,7 @@ FROM ${BASE_IMAGE} # Update conda base environment to match specifications in environment.yml ADD environment.yml /tmp/environment.yml USER root -RUN sed -i "s|name\: jupyter-quickstart|name\: base|g" /tmp/environment.yml # we need to replace the name of the environment with base such that we can update the base environment here +RUN sed -i "s|name\: jupyter-example-profile|name\: base|g" /tmp/environment.yml # we need to replace the name of the environment with base such that we can update the base environment here USER $NB_USER RUN conda env update -f /tmp/environment.yml # All packages specified in environment.yml are installed in the base environment diff --git a/Quickstart.ipynb b/Quickstart.ipynb index 3edd7438b7fea9c8d907bffa056d446ed6f2e6b0..796c617a2a6bb39ae606e5ab163aa29bdb8483c4 100644 --- a/Quickstart.ipynb +++ b/Quickstart.ipynb @@ -6,7 +6,7 @@ "source": [ "\n", "\n", - "# Jupyter Quickstart\n", + "# Jupyter Example Profile Quickstart\n", "\n", "Welcome to JupyterLab!\n", "\n", diff --git a/README.md b/README.md index 19c5e389004f426cc725e977d018561a75d29200..c36f1e083a2bf727fb2137bf7f4a0f106576085c 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -# Jupyter Quickstart +# Jupyter Example Profile ## Introduction This repository contains an exemplary Jupyter profile which works with the RWTH Jupyter server. To be more specific, it includes the following files * `Quickstart.ipynb` which is an exemplary Jupyter notebook file. -* `environment.yml` which specifies the required Python packages needed to run `Quickstart.ipynb`. +* `environment.yml` which specifies the required Python packages needed to run `Quickstart.ipynb`. This file is used by Anaconda or `conda`. * `Dockerfile` which defines the linux environment. In the end, the packages in `environment.yml` are installed and a `postBuild` script is executed afterwards. * `.gitlab-ci.yml` which specifies the necessary Docker build commands (which are executed every time `Dockerfile` changes in Git). -Run the notebook directly online [](https://mybinder.org/v2/git/https%3A%2F%2Fgit.rwth-aachen.de%2FIENT%2Fjupyter-quickstart/master?urlpath=lab/tree/index.ipynb) (the starting process of the session may take up to one minute). +Run the notebook directly online [](https://mybinder.org/v2/git/https%3A%2F%2Fgit.rwth-aachen.de%2Fjupyter%2Fexample-profile/master?urlpath=lab/tree/Quickstart.ipynb) (the starting process of the session may take up to one minute). ## Installation @@ -19,10 +19,10 @@ TBD ### Docker -For advanced users only: If you happen to have Docker installed, you can start a local dockerized JupyterLab with enabled GDET3-Demos with +For advanced users only: If you happen to have Docker installed, you can start a local dockerized JupyterLab with ```bash -docker run --name='jupyter-quickstart' --rm -it -p 8888:8888 -e JUPYTER_ENABLE_LAB=yes registry.git.rwth-aachen.de/ient/jupyter-quickstart:master +docker run --name='jupyter-example-profile' --rm -it -p 8888:8888 -e JUPYTER_ENABLE_LAB=yes registry.git-ce.rwth-aachen.de/jupyter/example-profile:master ``` Copy and paste the displayed link to your favorite browser. @@ -35,10 +35,10 @@ To run the notebooks on your local machine, you may use [Anaconda](https://www.a * Download this repository to your local disk. You can download it as a zip-File or use `git`: ```bash - git clone --recurse-submodules git@git.rwth-aachen.de:IENT/jupyter-quickstart.git + git clone --recurse-submodules git@git-ce.rwth-aachen.de:jupyter/example-profile.git ``` -* It is highly recommended to run the notebooks in an isolated Anaconda environment. You can create a new environment called `jupyter-quickstart` from the provided `environment.yml` by running the following command in the Anaconda prompt +* It is highly recommended to run the notebooks in an isolated Anaconda environment. You can create a new environment called `jupyter-example-profile` from the provided `environment.yml` by running the following command in the Anaconda prompt ```bash conda env create -f environment.yml @@ -48,10 +48,10 @@ To run the notebooks on your local machine, you may use [Anaconda](https://www.a * Activate this environment with ```bash - conda activate jupyter-quickstart + conda activate jupyter-example-profile ``` -* Run two final commands in the Anaconda prompt (with activated `jupyter-quickstart` environment): +* Run two final commands in the Anaconda prompt (with activated `jupyter-example-profile` environment): ```bash chmod +x binder/postBuild @@ -62,13 +62,13 @@ To run the notebooks on your local machine, you may use [Anaconda](https://www.a ### Local Run -* Activate the environment with `conda activate jupyter-quickstart`. +* Activate the environment with `conda activate jupyter-example-profile`. * Run JupyterLab `jupyter lab`. In your browser, JupyterLab should start. You can then open `index.ipynb` for an overview over all notebooks. * You can deactivate the environment with `conda deactivate`. ## Contact -* If you found a bug, please use the [issue tracker](https://git.rwth-aachen.de/IENT/jupyter-quickstart/issues). +* If you found a bug, please use the [issue tracker](https://git-ce.rwth-aachen.de/jupyter/example-profile/issues). * In all other cases, please contact [Christian Rohlfing](http://www.ient.rwth-aachen.de/cms/c_rohlfing/). The code is licensed under the [MIT license](https://opensource.org/licenses/MIT). diff --git a/environment.yml b/environment.yml index 46c093d664b633e0e224a8702ce0c68686744a8c..2393751f296e779b6284ca4fd6468071f13eca76 100644 --- a/environment.yml +++ b/environment.yml @@ -1,4 +1,4 @@ -name: jupyter-quickstart +name: jupyter-example-profile channels: - conda-forge dependencies: