|
| 1 | +# Orientation |
| 2 | + |
| 3 | +This orientation assumes you have already opened the training environment by clicking on the "Open in GitHub Codespaces" button. |
| 4 | +If not, please do so now, ideally in a second browser window or tab so you can refer back to these instructions. |
| 5 | + |
| 6 | +[](https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=290790519&skip_quickstart=true&machine=premiumLinux&devcontainer_path=.devcontainer%2Fdevcontainer.json) |
| 7 | + |
| 8 | +!!!warning "Machine size requirement" |
| 9 | + |
| 10 | + Make sure to select an **8-core machine** when creating your Codespace for this training course. The bioimaging workflows require additional compute resources. |
| 11 | + |
| 12 | +## GitHub Codespaces |
| 13 | + |
| 14 | +The GitHub Codespaces environment contains all the software, code and data necessary to work through this training course, so you don't need to install anything yourself. |
| 15 | +However, you do need a (free) GitHub account to log in, and if you are unfamiliar with the interface you should take a few minutes to familiarize yourself with it by completing the [GitHub Codespaces Orientation](../../envsetup/index.md) mini-course. |
| 16 | + |
| 17 | +## Pre-download Docker images |
| 18 | + |
| 19 | +Once you've opened your Codespace, let's pre-download all the Docker images we'll need for this training course. |
| 20 | +This will save time later and ensure smooth execution of the workflows. |
| 21 | + |
| 22 | +Open a new terminal tab and run the following command: |
| 23 | + |
| 24 | +```bash |
| 25 | +nextflow run nf-core/molkart -profile docker,test -stub -resume --outdir results |
| 26 | +``` |
| 27 | + |
| 28 | +This command will download all necessary Docker images in the background. |
| 29 | +You can continue with the rest of the orientation while this runs. |
| 30 | + |
| 31 | +!!!tip |
| 32 | + |
| 33 | + The `-stub` flag allows the pipeline to run quickly without processing real data, which is perfect for downloading images. You can monitor the progress in the terminal tab. |
| 34 | + |
| 35 | +## Working directory |
| 36 | + |
| 37 | +Throughout this training course, we'll be working in the `nf4-science/imaging/` directory. |
| 38 | + |
| 39 | +Change directory now by running this command in the terminal: |
| 40 | + |
| 41 | +```bash |
| 42 | +cd nf4-science/imaging/ |
| 43 | +``` |
| 44 | + |
| 45 | +!!!tip |
| 46 | + |
| 47 | + If for whatever reason you move out of this directory, you can always use the full path to return to it, assuming you're running this within the GitHub Codespaces training environment: |
| 48 | + |
| 49 | + ```bash |
| 50 | + cd /workspaces/training/nf4-science/imaging |
| 51 | + ``` |
| 52 | + |
| 53 | +**Now, to begin the course, click on the arrow in the bottom right corner of this page.** |
0 commit comments