binder-template

This is a template repo for running robotics research Jupyter Notebooks on Binderhub.

Quick Start: Start Transport Chain Swarm

• click on the binder item above and open the environment
• disable the simple switch in the bottom left corner
• open a virtual desktop from the launcher
• open a terminal and run in "repo" directory:
  • chmod +x ./Context-Role-Oriented-Transport-Chain-Swarm/VRBrun.sh
  • ./Context-Role-Oriented-Transport-Chain-Swarm/VRBrun.sh
• start the simulation in the virtual desktop in argos3
• open another terminal to start the Web App in chrome via:

google-chrome \
  --no-sandbox \
  --disable-dev-shm-usage \
  --disable-extensions \
  "http://localhost:5000" 

Launcher Urls

• JupyterLab: https://binder.intel4coro.de/v2/gh/IntEL4CoRo/binder-template.git/main?urlpath=lab/tree/notebooks/instructions.ipynb

• VScode: https://binder.intel4coro.de/v2/gh/XPhantomad/VRB-CROM-TransportChainSwarm2/binder-template.git/main?urlpath=vscode?folder=/home/repo

Create a new VRB lab from this template

1. Login to Github.

2. Use this template repository to create a new repository or fork it. Forking will make it easier to sync with future updates.

3. Clone your git repo, add your notebooks, python code, other files to the repo.

4. Modify the requirements.txt to install additional python packages.

5. Modify the binder/Dockerfile if your project needs additional APT packages.

   Examples:

   USER root
   RUN apt update
   RUN apt install -y ffmpeg

6. Use the following template to launch your notebook on Binder:

   https://binder.intel4coro.de/v2/gh/{GITHUB_USER_NAME}/{REPO_NAME}/{REPO_BRANCH}?urlpath=lab/tree/{NOTEBOOK_PATH}
   

   /XPhantomad/Context-Role-Oriented-Transport-Chain-Swarm.git

   https://binder.intel4coro.de/v2/gh/XPhantomad/Context-Role-Oriented-Transport-Chain-Swarm/main?urlpath=lab/tree/notebooks/mujoco.ipynb

   Replace each placeholder with your own information:

   • {GITHUB_USER_NAME} => Your GitHub username.
   • {REPO_NAME} => The name of your GitHub repository.
   • {REPO_BRANCH} => The branch of your repository.
   • {NOTEBOOK_PATH} => The relative path to the notebook file inside your repository (for example: notebooks/mujoco.ipynb).

   The first time it is launched, it will take some time to build the Docker image.

Use custom base docker image

You can also other based images, such as your own built docker images or official ROS images. And a few additional steps are required:

1. Install JupyterLab
2. Expose port 8888

Example Dockerfile use ROS1 official image:

FROM ros:noetic-ros-base

ENV SHELL=/bin/bash
ENV DEBIAN_FRONTEND=noninteractive

# Install jupyterlab and git
RUN apt-get update && apt-get install -y python3-pip git
RUN pip3 install jupyterlab

# Expose port for jupyterlab
EXPOSE 8888

# Copy repo to the image (optional)
ENV REPO_DIR=/home/repo
RUN mkdir -p ${REPO_DIR}
COPY . ${REPO_DIR}/
WORKDIR ${REPO_DIR}
# The entrypoint of the docker image
COPY binder/entrypoint.sh /entrypoint.sh
ENTRYPOINT ["/entrypoint.sh"]

Development

Run and build docker image Locally (Under repo directory)

• Build and run docker image:

  docker compose -f ./binder/docker-compose.yml up --build

• Open Web browser and go to http://localhost:8888/

• To stop and remove container:

  docker compose -f ./binder/docker-compose.yml down