[Tutorial] Add tutorail env setting scripts

Author: YWHyuk

.github/workflows/docker-tutorial-image.yml

@@ -30,6 +30,6 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
-          file: ./Dockerfile.ksc2025
+          file: ./tutorial/jupyterhub/Dockerfile.ksc2025
           push: true
           tags: ghcr.io/psal-postech/torchsim_ksc2025:latest

tutorial/jupyterhub/Dockerfile

@@ -0,0 +1,7 @@
+FROM jupyterhub/jupyterhub:latest
+
+RUN pip install --no-cache-dir \
+    dockerspawner \
+    jupyterhub-nativeauthenticator
+
+WORKDIR /srv/jupyterhub

Dockerfile.ksc2025 tutorial/jupyterhub/Dockerfile.ksc2025Dockerfile.ksc2025 renamed to tutorial/jupyterhub/Dockerfile.ksc2025

@@ -40,8 +40,8 @@ ENV PATH=$PATH:/root/.local/bin
 ENV LD_LIBRARY_PATH=/usr/lib/x86_64-linux-gnu:/opt/conda/lib:/usr/local/nvidia/lib:/usr/local/nvidia/lib64:$LD_LIBRARY_PATH
 
 # Build Gem5
-RUN git clone https://github.com/PSAL-POSTECH/gem5.git --branch TorchSim
-RUN cd gem5 && scons build/RISCV/gem5.opt -j $(nproc)
+RUN git clone https://github.com/PSAL-POSTECH/gem5.git --branch tutorial
+RUN cd gem5 && scons build/RISCV/gem5.opt -j $(nproc) && git checkout TorchSim
 ENV GEM5_PATH=/workspace/gem5/build/RISCV/gem5.opt
 
 # Build LLVM RISC-V
@@ -87,4 +87,6 @@ RUN cd PyTorchSim/TOGSim && \
     cd build && \
     conan install .. --build=missing && \
     cmake .. && \
-    make -j$(nproc)
+    make -j$(nproc)
+
+RUN pip install jupyterhub jupyterlab

tutorial/jupyterhub/docker-compose.yml

@@ -0,0 +1,25 @@
+version: '3'
+
+services:
+  jupyterhub:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: jupyterhub
+    image: my-jupyterhub-image
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+      - ./jupyterhub_config.py:/srv/jupyterhub/jupyterhub_config.py
+    environment:
+      # DockerSpawner가 사용할 네트워크 이름
+      DOCKER_NETWORK_NAME: jupyterhub-network
+      # Hub가 내부적으로 사용할 IP
+      HUB_IP: jupyterhub
+    ports:
+      - "8000:8000"
+    networks:
+      - jupyterhub-network
+
+networks:
+  jupyterhub-network:
+    external: true

tutorial/jupyterhub/jupyterhub_config.py

@@ -0,0 +1,28 @@
+import os
+
+c = get_config()
+
+# ------------------------------------------------------------------------------
+# Spawner config
+# ------------------------------------------------------------------------------
+c.JupyterHub.spawner_class = 'dockerspawner.DockerSpawner'
+c.DockerSpawner.image = "torchsim-ksc2025:latest"
+
+# Resource limit
+c.DockerSpawner.mem_limit = '16G'
+c.DockerSpawner.cpu_limit = 4.0
+
+c.DockerSpawner.network_name = 'jupyterhub-network'
+c.Spawner.default_url = '/lab'
+c.Spawner.ip = '0.0.0.0'
+c.DockerSpawner.remove = False
+c.DockerSpawner.cmd = ["jupyterhub-singleuser", "--allow-root"]
+
+c.JupyterHub.authenticator_class = 'nativeauthenticator.NativeAuthenticator'
+c.Authenticator.admin_users = {'admin'}
+
+c.JupyterHub.hub_ip = 'jupyterhub'
+c.JupyterHub.hub_port = 8081
+
+c.NativeAuthenticator.open_signup = True
+c.NativeAuthenticator.allow_all = True

tutorial/jupyterhub/setting.sh

@@ -0,0 +1,5 @@
+if [ -z "$(docker network ls | grep jupyterhub-network)" ]; then
+    docker network create jupyterhub-network
+fi
+
+docker compose up -d --build