Skip to content

Commit 7e594a6

Browse files
kenibrewerclaudeashdederichpinin4fjordsFloWuenne
authored
✨ feat: nextflow run for bioimaging (#680)
* devexp 💻: add live preview vscode ext for multiqc viewing * ✨ feat(training): add Nextflow for Bioimaging course Add comprehensive training course for running nf-core/molkart pipeline and spatial transcriptomics bioimaging workflows. Includes: - Course documentation with orientation, basics, and molkart execution - Input configuration and parameter customization guides - Example workflows (hello-world.nf) and sample data - Integration into nf4_science training collection This course teaches users how to run bioimaging pipelines using the Nextflow Run pattern with nf-core/molkart as the primary example. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> * 📝 docs(imaging): complete Nextflow run for Imaging course content Complete the imaging course documentation with comprehensive coverage of running nf-core/molkart pipeline including inputs and configuration. - Streamline orientation page, remove redundant content - Add molkart pipeline diagram (img/molkart.png) - Improve Part 2 with clearer explanations and output examples - Complete Part 3 with parameter files and samplesheet examples - Complete Part 4 with configuration profiles and resource management - Update course title to "Nextflow run for Imaging" - Add Parts 3 and 4 to navigation in mkdocs.yml 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> * 📝 docs(imaging): apply suggestions from code review │ Update imaging course documentation with improved clarity and consistency: - Clarify file content descriptions in basics module - Add cross-reference to Hello nf-core course - Update command examples to use tree instead of ls - Enhance explanations of nf-core conventions and resume functionality - Improve configuration section clarity on profiles and process labels - Remove training subset section to streamline course flow Co-Authored-By: ashdederich <[email protected]> Co-Authored-By: pinin4fjords <[email protected]> * 📝 docs(imaging): cleanup content prior to release * 📑 docs (imaging): apply suggestions from code review Co-authored by: Florian Wuennemann <[email protected]> * 📊 survey: add survey link for imaging course --------- Co-authored-by: Claude <[email protected]> Co-authored-by: ashdederich <[email protected]> Co-authored-by: pinin4fjords <[email protected]> Co-authored-by: Florian Wuennemann <[email protected]>
1 parent d2879ef commit 7e594a6

File tree

21 files changed

+1793
-3
lines changed

21 files changed

+1793
-3
lines changed

.devcontainer/codespaces-dev/devcontainer.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,10 @@
4040
"onCreateCommand": "bash .devcontainer/setup.sh",
4141
"customizations": {
4242
"vscode": {
43-
"extensions": ["nf-core.nf-core-extensionpack"],
43+
"extensions": [
44+
"nf-core.nf-core-extensionpack",
45+
"ms-vscode.live-server"
46+
],
4447
// Use Python from conda
4548
"settings": {
4649
"python.defaultInterpreterPath": "/opt/conda/bin/python"

.devcontainer/devcontainer.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,10 @@
2020
"onCreateCommand": "bash .devcontainer/setup.sh",
2121
"customizations": {
2222
"vscode": {
23-
"extensions": ["nf-core.nf-core-extensionpack"],
23+
"extensions": [
24+
"nf-core.nf-core-extensionpack",
25+
"ms-vscode.live-server"
26+
],
2427
// Use Python from conda
2528
"settings": {
2629
"python.defaultInterpreterPath": "/opt/conda/bin/python"

.devcontainer/local-dev/devcontainer.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,10 @@
4242
"postCreateCommand": "mkdir -p /workspaces && rm -rf /workspaces/training && ln -s ${localWorkspaceFolder} /workspaces/training",
4343
"customizations": {
4444
"vscode": {
45-
"extensions": ["nf-core.nf-core-extensionpack"],
45+
"extensions": [
46+
"nf-core.nf-core-extensionpack",
47+
"ms-vscode.live-server"
48+
],
4649
// Use Python from conda
4750
"settings": {
4851
"python.defaultInterpreterPath": "/opt/conda/bin/python",

docs/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,16 @@ These are courses that demonstrate how to apply the concepts and components pres
100100

101101
[Start the Nextflow for RNAseq training :material-arrow-right:](nf4_science/rnaseq/){ .md-button .md-button--primary }
102102

103+
!!! exercise "Nextflow for Imaging"
104+
105+
!!! tip inline end ""
106+
107+
:material-microscope:{.nextflow-primary} Learn to run pipelines for spatial transcriptomics imaging data in Nextflow.
108+
109+
This is a course for researchers in imaging and spatial omics who wish to learn how to run and customize analysis pipelines. The course uses the nf-core/molkart pipeline to provide a biologically-relevant pipeline demonstrate how to run, configure, and manage inputs for Nextflow pipelines workflows.
110+
111+
[Start the Nextflow for Imaging training :material-arrow-right:](nf4_science/imaging/){ .md-button .md-button--primary }
112+
103113
Let us know what other domains and use cases you'd like to see covered here by posting in the [Training section](https://community.seqera.io/c/training/) of the community forum.
104114

105115
## Advanced Nextflow Training
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
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://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

Comments
 (0)