From 628d814f9faceaf506ff34504800fed917c08efb Mon Sep 17 00:00:00 2001 From: ahughesuol Date: Mon, 29 Jul 2024 14:20:29 +0100 Subject: [PATCH] added everything --- .github/workflows/docker-publish.yml | 6 +++--- .../.devcontainer/Dockerfile | 1 + .../.devcontainer/devcontainer.json | 2 +- .../test.ipynb | 0 README.md | 10 +++++----- 5 files changed, 10 insertions(+), 9 deletions(-) rename {MODULE => CMP9065 Data Programming in Python}/.devcontainer/Dockerfile (51%) rename {MODULE => CMP9065 Data Programming in Python}/.devcontainer/devcontainer.json (92%) rename {MODULE => CMP9065 Data Programming in Python}/test.ipynb (100%) diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml index ad00869..c008d3b 100644 --- a/.github/workflows/docker-publish.yml +++ b/.github/workflows/docker-publish.yml @@ -67,7 +67,7 @@ jobs: id: meta uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # v5.0.0 with: - images: ghcr.io/socstech/MODULE # THIS LINE MUST BE EDITED FOR NEW MODULES + images: ghcr.io/socstech/cmp9065 # THIS LINE MUST BE EDITED FOR NEW MODULES # Build and push Docker image with Buildx (don't push on PR) @@ -77,12 +77,12 @@ jobs: uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0 with: context: . - file: ./MODULE FOLDER/.devcontainer/Dockerfile # THIS LINE MUST BE EDITED FOR NEW MODULES + file: ./CMP9065 Data Programming in Python/.devcontainer/Dockerfile # THIS LINE MUST BE EDITED FOR NEW MODULES push: ${{ github.event_name != 'pull_request' }} # THIS LINE MUST BE EDITED FOR NEW MODULES tags: | ${{ steps.meta.outputs.tags }} - ghcr.io/socstech/MODULE:latest + ghcr.io/socstech/cmp9065:latest labels: ${{ steps.meta.outputs.labels }} cache-from: type=gha cache-to: type=gha,mode=max diff --git a/MODULE/.devcontainer/Dockerfile b/CMP9065 Data Programming in Python/.devcontainer/Dockerfile similarity index 51% rename from MODULE/.devcontainer/Dockerfile rename to CMP9065 Data Programming in Python/.devcontainer/Dockerfile index 50910b3..8cec527 100644 --- a/MODULE/.devcontainer/Dockerfile +++ b/CMP9065 Data Programming in Python/.devcontainer/Dockerfile @@ -1,4 +1,5 @@ FROM python:3.12 RUN pip install --upgrade pip +RUN pip install scikit-learn scikit-image seaborn matplotlib numpy pandas scipy RUN pip install ipykernel CMD ["clear"] \ No newline at end of file diff --git a/MODULE/.devcontainer/devcontainer.json b/CMP9065 Data Programming in Python/.devcontainer/devcontainer.json similarity index 92% rename from MODULE/.devcontainer/devcontainer.json rename to CMP9065 Data Programming in Python/.devcontainer/devcontainer.json index 1671112..67ad783 100644 --- a/MODULE/.devcontainer/devcontainer.json +++ b/CMP9065 Data Programming in Python/.devcontainer/devcontainer.json @@ -1,7 +1,7 @@ { "name": "MODULE", - "image": "ghcr.io/socstech/MODULE:latest", + "image": "ghcr.io/socstech/cmp9065:latest", //"build": { "dockerfile": "Dockerfile" }, diff --git a/MODULE/test.ipynb b/CMP9065 Data Programming in Python/test.ipynb similarity index 100% rename from MODULE/test.ipynb rename to CMP9065 Data Programming in Python/test.ipynb diff --git a/README.md b/README.md index a38e652..a7f3d6d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# MODULE TITLE -This repository houses the devcontainer and docker image for the MODULE module at the University of Lincoln. +# CMP9065 - Data Programming in Python +This repository houses the devcontainer and docker image for the Data Programming in Python module at the University of Lincoln. ## What is Docker? Docker is a platform which allows developers to create and share containers. @@ -28,13 +28,13 @@ These prerequisites are the same for every Computer Science module using Docker 1. Clone this repository to your computer by clicking the green 'Code' button, and clicking 'Download ZIP'. 2. Extract the downloaded Zip file. -3. Inside the extracted folder is a folder entitled 'MODULE FOLDER' which contains the .devcontainer folder. Move 'MODULE FOLDER' to wherever you like, this will be your working directory for this module. +3. Inside the extracted folder is a folder entitled 'CMP9065 Data Programming in Python' which contains the .devcontainer folder. Move 'CMP9065 Data Programming in Python' to wherever you like, this will be your working directory for this module. 4. Make sure Docker Desktop is running. You can minimise the window. -5. Open VS Code, go to File -> Open Folder, and select your 'MODULE FOLDER' folder. +5. Open VS Code, go to File -> Open Folder, and select your 'CMP9065 Data Programming in Python' folder. 6. Click the 'Reopen in container' pop up in the bottom right corner of your VS Code window. If you do not see this pop up, press F1, and type 'Reopen in Container', and click on the 'Dev Containers: Reopen in Container' command. 7. The Docker image will now be downloaded, and the container will be started. You can click 'show log' in the bottom right corner to see what is going on. 8. Your docker container is now running! Within this VS Code window, you can now run workshop or assignment material exactly the same as in the computing labs. -9. If we ever push an update to the container, you will need to go to Docker Desktop -> Images, find ghcr.io/socstech/MODULE, click the ... button, and click pull. This will pull the most recent version of the docker container. There should be Blackboard announcements letting you know if you ever need to do this, but it is good to do this step every time before you want to use the container. +9. If we ever push an update to the container, you will need to go to Docker Desktop -> Images, find ghcr.io/socstech/cmp9065, click the ... button, and click pull. This will pull the most recent version of the docker container. There should be Blackboard announcements letting you know if you ever need to do this, but it is good to do this step every time before you want to use the container. ### Troubleshooting