Skip to content

First pass of the Nextflow Run course #626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 53 commits into from
Jul 20, 2025
Merged
Show file tree
Hide file tree
Changes from 47 commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
5e82968
definitive contents outline
vdauwera Jun 4, 2025
2f50afb
First pass of the nextflow run basics section
vdauwera Jun 20, 2025
332667f
Merge branch 'master' into gvda-nextflow-run
vdauwera Jun 20, 2025
4715c09
fix header
vdauwera Jun 20, 2025
929e722
Merge branch 'gvda-nextflow-run' of https://github.com/nextflow-io/tr…
vdauwera Jun 20, 2025
1fc4eb4
Part 2 — from channels to containers
vdauwera Jun 20, 2025
6586d23
config needs to be streamlined more
vdauwera Jun 20, 2025
a3f06ca
fix headers
vdauwera Jun 20, 2025
dbf4bcf
add new course
vdauwera Jun 20, 2025
192024a
Minor updates
vdauwera Jun 20, 2025
ec5e526
attempt to fix issue with rendering
vdauwera Jun 20, 2025
e062ad1
second fix
vdauwera Jun 20, 2025
6803cd7
Streamlined the basic operations section
vdauwera Jul 3, 2025
8a80314
Added nextflow log and finished streamlining
vdauwera Jul 4, 2025
085e5e2
Update the channels, workflow, modules and containers (pt 1)
vdauwera Jul 4, 2025
a8d3611
added collapsible sections as an experiment
vdauwera Jul 5, 2025
969a1c7
fix formatting error
vdauwera Jul 5, 2025
f193690
Make explanations and code snippets collapsible
vdauwera Jul 5, 2025
79d399a
Remove explanation collapsibles because it kills formatting
vdauwera Jul 5, 2025
7cc7bbf
Finalize content and formatting for Part 2
vdauwera Jul 5, 2025
ade9234
Tweaked display in Part 1 for consistency with Part 2
vdauwera Jul 5, 2025
6cc9c37
Minor tweaks
vdauwera Jul 5, 2025
2857bba
renamed workflow files
vdauwera Jul 5, 2025
39a172f
Cleaned up and reordered Config (order was messed up..?)
vdauwera Jul 5, 2025
6f5a424
fix headings
vdauwera Jul 5, 2025
f7f2a4b
Tweak index
vdauwera Jul 5, 2025
2dc7cee
minor tweaks
vdauwera Jul 5, 2025
a63bd7a
Update orientation with final contents
vdauwera Jul 7, 2025
9083a16
Merge branch 'master' into gvda-nextflow-run
vdauwera Jul 7, 2025
f691189
fix for bad closing tag
vdauwera Jul 7, 2025
b672d9a
Merge branch 'gvda-nextflow-run' of https://github.com/nextflow-io/tr…
vdauwera Jul 7, 2025
6d1299c
Minor fixes to Part I
mribeirodantas Jul 16, 2025
1ffb305
Minor fixes to Part II of Nextflow Run
mribeirodantas Jul 16, 2025
f50ad29
Remove newline at the end
mribeirodantas Jul 17, 2025
515f590
Minor fixes to Part III of Nextflow Run
mribeirodantas Jul 17, 2025
2465371
Apply suggestions from code reviews
vdauwera Jul 19, 2025
dca393b
update json to yaml
vdauwera Jul 19, 2025
502eadb
fix prettier issues (mermaid?)
vdauwera Jul 19, 2025
28fd3bc
Fixed and expanded the run-specific config
vdauwera Jul 19, 2025
8fcd0e8
Improved headers
vdauwera Jul 19, 2025
d76c3bf
Fixed formatting error to details box
vdauwera Jul 19, 2025
62fa6e7
take out mermaid code (not rendering)
vdauwera Jul 19, 2025
3e2ddf9
code box is glitching
vdauwera Jul 19, 2025
a8cb72a
temp test
vdauwera Jul 19, 2025
5d100ab
test 2
vdauwera Jul 19, 2025
d2f17c4
test 3
vdauwera Jul 19, 2025
d243f75
should be fixed now
vdauwera Jul 19, 2025
a63e9f3
fix path
vdauwera Jul 19, 2025
3cb6172
Added diagrams
vdauwera Jul 19, 2025
09e0721
fix img paths (facepalm)
vdauwera Jul 19, 2025
b4c115c
switch dag preview to png as the svg is not working correctly
vdauwera Jul 19, 2025
e469a4b
Final tweaks
vdauwera Jul 19, 2025
9b50d3a
one more fix
vdauwera Jul 20, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions docs/nextflow_run/00_orientation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Orientation

This orientation assumes you have already opened the training environment by clicking on the "Open in GitHub Codespaces" button.
If not, please do so now, ideally in a second browser window or tab so you can refer back to these instructions.

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/nextflow-io/training?quickstart=1&ref=master)

## GitHub Codespaces

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.
However, you do need a (free) GitHub account to log in, and you should take a few minutes to familiarize yourself with the interface.

If you have not yet done so, please go through the [Environment Setup](../../envsetup/) mini-course before going any further.

## Working directory

Throughout this training course, we'll be working in the `nextflow-run/` directory.

Change directory now by running this command in the terminal:

```bash
cd nextflow-run/
```

!!!tip

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:

```bash
cd /workspaces/training/nextflow-run
```

Now let's have a look at the contents of this directory.

## Materials provided

You can explore the contents of this directory by using the file explorer on the left-hand side of the training workspace.
Alternatively, you can use the `tree` command.

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.

Here we generate a table of contents to the second level down:

```bash
tree . -L 2
```

If you run this inside `nextflow-run`, you should see the following output:

```console title="Directory contents"
.
├── 1-hello.nf
├── 2a-inputs.nf
├── 2b-multistep.nf
├── 2c-modules.nf
├── 2d-container.nf
├── 3-main.nf
├── modules
│ ├── collectGreetings.nf
│ ├── convertToUpper.nf
│ ├── cowpy.nf
│ └── sayHello.nf
├── nextflow.config
└── test-params.json

1 directory, 12 files
```

**Here's a summary of what you should know to get started:**

- **The `.nf` files** are workflow scripts that are numbered based on what part of the course they're used in.

- **The file `nextflow.config`** is a configuration file that sets minimal environment properties.
You can ignore it for now.

- **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.

- **The file `test-params.json`** is a file we'll use in Part 3. You can ignore it for now.

**Now, to begin the course, click on the arrow in the bottom right corner of this page.**
Loading