jupyter-mentor

Developing locally with conda

Assuming you have conda installed…

1. Create a new environment using version 3.11 of python with the following command:

conda create -f environment.yml

2. Go to the directory of your cloned repository and activate your envrionment:

conda activate jupyter-mentor

3. Open the JupyterLab editor:

cd path/to/your/cloned/repo
jupyter lab

Developing with Docker

WARNING! Development with Docker is not recommended at this time. However, GitHub actions runs repo2docker to verify that this repository is compatible with Binder.

Developing on MacOS

1. Install Docker with brew install --cask docker. If this command does not work, you may need to install Homebrew
2. Start Docker by clicking on application icon or by running open -a Docker
3. Pull the docker image from DockerHub to you local machine using docker image pull brewer36/jupyter-mentor:macos
4. cd <location_of_your_clone>
5. Launch JupyterLab with docker run -it --rm -p 8888:8888 brewer36/jupyter-mentor:macos jupyter lab --ip=0.0.0.0 --port=8888

Updating brewer36/jupyter-mentor:latest (linux) image with GitHub acitons

No extra steps required. This GitHub action automatically updates the image with each new commit.

Updating brewer36/jupyter-mentor:macos (arm64 for M1 chip) image with repo2docker

1. Install repo2docker with python3 -m pip install jupyter-repo2docker
2. cd <location_of_your_clone>
3. repo2docker --Repo2Docker.platform=linux/arm64 --image-name=brewer36/jupyter-mentor:macos ./