Skip to content

Commit 786d395

Browse files
authored
First pass of the Nextflow Run course (#626)
Abridged version of Hello Nextflow focused on running rather than developing. - Run basic operations (Hello World level) - Run pipelines (channels for multiple inputs, multi-step example, modules, containers) - Configuration
1 parent d4c3118 commit 786d395

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+3116
-1492
lines changed

docs/nextflow_run/00_orientation.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
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+
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/nextflow-io/training?quickstart=1&ref=master)
7+
8+
## GitHub Codespaces
9+
10+
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.
11+
However, you do need a (free) GitHub account to log in, and you should take a few minutes to familiarize yourself with the interface.
12+
13+
If you have not yet done so, please go through the [Environment Setup](../../envsetup/) mini-course before going any further.
14+
15+
## Working directory
16+
17+
Throughout this training course, we'll be working in the `nextflow-run/` directory.
18+
19+
Change directory now by running this command in the terminal:
20+
21+
```bash
22+
cd nextflow-run/
23+
```
24+
25+
!!!tip
26+
27+
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:
28+
29+
```bash
30+
cd /workspaces/training/nextflow-run
31+
```
32+
33+
Now let's have a look at the contents of this directory.
34+
35+
## Materials provided
36+
37+
You can explore the contents of this directory by using the file explorer on the left-hand side of the training workspace.
38+
Alternatively, you can use the `tree` command.
39+
40+
Throughout the course, we use the output of `tree` to represent directory structure and contents in a readable form, sometimes with minor modifications for clarity.
41+
42+
Here we generate a table of contents to the second level down:
43+
44+
```bash
45+
tree . -L 2
46+
```
47+
48+
If you run this inside `nextflow-run`, you should see the following output:
49+
50+
```console title="Directory contents"
51+
.
52+
├── 1-hello.nf
53+
├── 2a-inputs.nf
54+
├── 2b-multistep.nf
55+
├── 2c-modules.nf
56+
├── 2d-container.nf
57+
├── 3-main.nf
58+
├── modules
59+
│ ├── collectGreetings.nf
60+
│ ├── convertToUpper.nf
61+
│ ├── cowpy.nf
62+
│ └── sayHello.nf
63+
├── nextflow.config
64+
└── test-params.yaml
65+
66+
1 directory, 12 files
67+
```
68+
69+
**Here's a summary of what you should know to get started:**
70+
71+
- **The `.nf` files** are workflow scripts that are numbered based on what part of the course they're used in.
72+
73+
- **The file `nextflow.config`** is a configuration file that sets minimal environment properties.
74+
You can ignore it for now.
75+
76+
- **The file `greetings.csv`** contains input data we'll use in most of the course. It is described in Part 2, when we introduce it for the first time.
77+
78+
- **The file `test-params.yaml`** is a file we'll use in Part 3. You can ignore it for now.
79+
80+
**Now, to begin the course, click on the arrow in the bottom right corner of this page.**

0 commit comments

Comments
 (0)