Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
daphnejanelyn committed Jan 9, 2025
2 parents 494b3b6 + aebe725 commit a01ae61
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ This guide outlines the steps to **pull** a Docker image, mount necessary direct
Note: Make sure you are running Docker Desktop or started your docker engine before performing any of the commands below.
### Step 1: Pull the Docker Image
First, you need to pull the Docker image from the registry (e.g., Docker Hub). Use the following command to pull the `daphnejanelyn123/metagenomics-workshop` image:
First, you need to pull the Docker image from the registry (e.g., Docker Hub). Use the following command to pull the image:
docker pull daphnejanelyn123/metagenomics-workshop
`docker pull ghcr.io/bioinfodlsu/metagenomics-workshop/deploy:latest`
This command fetches the image and prepares it for running in a container.
Expand All @@ -43,16 +43,16 @@ This command fetches the image and prepares it for running in a container.
You’ll want to mount your local directories to the Docker container to ensure that your notebooks, data, and results are accessible inside the container.
Here’s a breakdown of the directories being mounted:
- **Data**: Your local path `path_to_your_data_directory (e.g., C:/Users/Daphne Go/.docker/bioinformatics/data)` containing the data will be mounted to `/home/jovyan/data` in the container. The data should be downloaded from the data folder located in this Drive Link (https://drive.google.com/drive/folders/1pfcwepIvSYmJ_wBp668jbVYR8nekrSF3?usp=sharing). Ensure that the required data files are placed in this directory before running the container.
- **Notebooks**: Your local path `path_to_your_notebooks_directory (e.g., C:/Users/Daphne Go/.docker/bioinformatics/notebooks)` will be mounted to `/home/jovyan/notebooks` in the container. The notebooks should be downloaded from the **notebooks folder in the Github repository provided**. Place your Jupyter notebooks into this local directory before running the container.
- **Data**: Your local path `path_to_your_data_directory` containing the data will be mounted to `/home/jovyan/data` in the container. The data should be downloaded from the data folder located in this Drive Link (https://drive.google.com/drive/folders/1pfcwepIvSYmJ_wBp668jbVYR8nekrSF3?usp=sharing). Ensure that the required data files are placed in this directory before running the container.
- **Notebooks**: Your local path `path_to_your_notebooks_directory` will be mounted to `/home/jovyan/notebooks` in the container. The notebooks should be downloaded from the **notebooks folder in the Github repository provided**. Place your Jupyter notebooks into this local directory before running the container.
Make sure your data and notebooks are placed in your specified local directories before running the container.
### Step 3: Run the Docker Container
Once the image is pulled and your directories are set up, run the Docker container with the following command:
```
docker run -u root -e NB_USER="root" -e NB_UID=0 -e NB_GID=0 -e NOTEBOOK_ARGS="--allow-root" -p 8888:8888 -v "path_to_your_data_directory:/home/jovyan/data" -v "path_to_your_notebooks_directory:/home/jovyan/notebooks" daphnejanelyn123/metagenomics-workshop: metagenomics-workshop
docker run -u root -e NB_USER="root" -e NB_UID=0 -e NB_GID=0 -e NOTEBOOK_ARGS="--allow-root" -p 8888:8888 -v "path_to_your_data_directory:/home/jovyan/data" -v "path_to_your_notebooks_directory:/home/jovyan/notebooks" ghcr.io/bioinfodlsu/metagenomics-workshop/deploy:latest
```
Note: Please remember to replace the paths with your corresponding data and notebook directories.
Expand Down

0 comments on commit a01ae61

Please sign in to comment.