|
4 | 4 |
|
5 | 5 | ### STEP 0: Setup (one time only) |
6 | 6 |
|
7 | | -1. **Make sure Docker Desktop is running** |
| 7 | +**Complete these steps IN ORDER:** |
8 | 8 |
|
9 | | -2. **Login to Docker Hub:** |
10 | | - ```bash |
11 | | - docker login |
12 | | - ``` |
13 | | - Enter your Docker Hub username and password. |
| 9 | +#### 1. Open VSCode |
14 | 10 |
|
15 | | -3. **Pull the container:** |
16 | | - ```bash |
17 | | - docker pull cosmelab/dna-barcoding-analysis:latest |
18 | | - ``` |
| 11 | +Open Visual Studio Code on your computer (Mac or Windows). |
| 12 | + |
| 13 | +#### 2. Open Terminal in VSCode |
| 14 | + |
| 15 | +- **Mac:** Press `Control + ~` (tilde) or go to Terminal → New Terminal |
| 16 | +- **Windows:** Press `Ctrl + ~` or go to Terminal → New Terminal |
| 17 | + |
| 18 | +You should see a terminal window at the bottom of VSCode. |
| 19 | + |
| 20 | +#### 3. Navigate to Where You Want the Project |
| 21 | + |
| 22 | +```bash |
| 23 | +# Example: Go to your Documents folder |
| 24 | +cd ~/Documents |
| 25 | + |
| 26 | +# Or create a course folder first |
| 27 | +mkdir -p ~/Documents/ENTM201L |
| 28 | +cd ~/Documents/ENTM201L |
| 29 | +``` |
| 30 | + |
| 31 | +#### 4. Check Docker is Running |
| 32 | + |
| 33 | +**IMPORTANT:** Make sure Docker Desktop is running BEFORE continuing! |
| 34 | + |
| 35 | +```bash |
| 36 | +# Check Docker is installed and running |
| 37 | +docker --version |
| 38 | +``` |
| 39 | + |
| 40 | +**Expected output:** `Docker version 24.x.x` or similar |
| 41 | + |
| 42 | +**If you get an error:** |
| 43 | +- Open Docker Desktop application |
| 44 | +- Wait for it to fully start (whale icon stops animating) |
| 45 | +- Try `docker --version` again |
| 46 | + |
| 47 | +#### 5. Login to Docker Hub |
| 48 | + |
| 49 | +```bash |
| 50 | +docker login |
| 51 | +``` |
| 52 | + |
| 53 | +Enter your Docker Hub username and password when prompted. |
19 | 54 |
|
20 | | -4. **Get your assignment repository:** |
| 55 | +**Expected output:** `Login Succeeded` |
21 | 56 |
|
22 | | - **GitHub Classroom students - IMPORTANT:** |
| 57 | +#### 6. Pull the Analysis Container |
23 | 58 |
|
24 | | - a. **Click the assignment link from Canvas** |
| 59 | +```bash |
| 60 | +docker pull cosmelab/dna-barcoding-analysis:latest |
| 61 | +``` |
| 62 | + |
| 63 | +This downloads the container (~2.5GB). Wait for it to complete. |
| 64 | + |
| 65 | +#### 7. Get Your Assignment Repository |
| 66 | + |
| 67 | +**GitHub Classroom students - IMPORTANT:** |
| 68 | + |
| 69 | +a. **Click the assignment link from Canvas** |
25 | 70 |
|
26 | | - b. **Accept the assignment** - this creates YOUR personal repo |
| 71 | +b. **Accept the assignment** - this creates YOUR personal repo |
27 | 72 |
|
28 | | - c. **Refresh the page** to see your new repository |
| 73 | +c. **Refresh the page** to see your new repository |
29 | 74 |
|
30 | | - d. **Copy the clone URL** from the green Code button |
| 75 | +d. **Copy the clone URL** from the green Code button |
31 | 76 |
|
32 | | - e. **Clone your repo:** |
| 77 | +e. **Clone your repo in the terminal:** |
33 | 78 | ```bash |
34 | 79 | git clone YOUR-REPO-URL |
35 | 80 | cd dna-barcoding-analysis-YOUR-GITHUB-USERNAME |
36 | 81 | ``` |
37 | 82 |
|
| 83 | + Replace `YOUR-REPO-URL` with the URL you copied! |
| 84 | + Replace `YOUR-GITHUB-USERNAME` with your actual GitHub username! |
| 85 | + |
38 | 86 | Git will automatically prompt you to login to GitHub. |
39 | 87 |
|
40 | | - **Or if using the template directly (not GitHub Classroom):** |
41 | | - ```bash |
42 | | - git clone https://github.com/cosmelab/dna-barcoding-analysis.git |
43 | | - cd dna-barcoding-analysis |
44 | | - ``` |
| 88 | +**Or if using the template directly (not GitHub Classroom):** |
| 89 | +```bash |
| 90 | +git clone https://github.com/cosmelab/dna-barcoding-analysis.git |
| 91 | +cd dna-barcoding-analysis |
| 92 | +``` |
| 93 | + |
| 94 | +#### 8. Verify You're in the Right Place |
| 95 | + |
| 96 | +```bash |
| 97 | +# Check you're in the project directory |
| 98 | +ls |
| 99 | +``` |
| 100 | + |
| 101 | +**You should see:** `tutorial.sh`, `run-analysis.sh`, `data/`, `modules/`, etc. |
| 102 | + |
| 103 | +**Now you're ready to run the analysis!** |
45 | 104 |
|
46 | 105 | --- |
47 | 106 |
|
@@ -73,6 +132,25 @@ docker run --rm -it -v $(pwd):/workspace -w /workspace \ |
73 | 132 |
|
74 | 133 | --- |
75 | 134 |
|
| 135 | +## ⚠️ IMPORTANT: Where to Run Commands |
| 136 | + |
| 137 | +**Run all commands ON YOUR COMPUTER (Mac/Windows/Linux), NOT inside Docker!** |
| 138 | + |
| 139 | +✅ **CORRECT:** |
| 140 | +- Open terminal/VSCode on your Mac or Windows computer |
| 141 | +- Navigate to your project folder |
| 142 | +- Run `./tutorial.sh` from there |
| 143 | +- The script automatically uses Docker for you |
| 144 | + |
| 145 | +❌ **WRONG:** |
| 146 | +- Don't try to run commands inside the Docker container |
| 147 | +- Don't manually start Docker and work inside it |
| 148 | +- The scripts handle Docker automatically! |
| 149 | + |
| 150 | +**Think of Docker like a tool:** The scripts call Docker for you. You don't need to "go inside" Docker. |
| 151 | + |
| 152 | +--- |
| 153 | + |
76 | 154 | ### STEP 1: Learn the Workflow (REQUIRED - 15 minutes) |
77 | 155 |
|
78 | 156 | **Run the tutorial with test data:** |
|
0 commit comments