Skip to content
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

Hello-seqera #413

Merged
merged 5 commits into from
Oct 28, 2024
Merged

Hello-seqera #413

merged 5 commits into from
Oct 28, 2024

Conversation

kenibrewer
Copy link
Member

@kenibrewer kenibrewer commented Oct 25, 2024

This adds the first two sections of hello_seqera a training module intended to provide a hands-on approach to learning Nextflow.

The main portions covered are:

  1. Running Nextflow jobs from the cli -with-tower.
  2. Launching nextflow runs within Seqera Platform in a pre-configured compute environment.

I had intended to include more content including a simulated Compute Environment setup, but I decided that approach needs more work (specifically we need to figure which of the HPC executors we can run from within a Devcontainer). That partial work has been moved into #420.

Copy link

netlify bot commented Oct 25, 2024

Deploy Preview for nextflow-training ready!

Name Link
🔨 Latest commit a917fe7
🔍 Latest deploy log https://app.netlify.com/sites/nextflow-training/deploys/671ed5e936b54300089950ff
😎 Deploy Preview https://deploy-preview-413--nextflow-training.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@pinin4fjords pinin4fjords left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few early comments, apologies if you weren't looking for review just yet, @vdauwera pointed me in this direction ;-)

docs/hello_nextflow/10_hello_seqera.md Show resolved Hide resolved
docs/hello_nextflow/10_hello_seqera.md Show resolved Hide resolved
docs/hello_nextflow/10_hello_seqera.md Outdated Show resolved Hide resolved
docs/hello_nextflow/10_hello_seqera.md Outdated Show resolved Hide resolved
docs/hello_nextflow/10_hello_seqera.md Outdated Show resolved Hide resolved
docs/hello_nextflow/10_hello_seqera.md Outdated Show resolved Hide resolved
docs/hello_nextflow/10_hello_seqera.md Outdated Show resolved Hide resolved
docs/hello_nextflow/10_hello_seqera.md Outdated Show resolved Hide resolved
@kenibrewer kenibrewer force-pushed the feat/hello-seqera branch 2 times, most recently from 6c172f3 to 7ef3682 Compare October 25, 2024 17:43
@kenibrewer
Copy link
Member Author

Thanks @pinin4fjords for the early comments. Unfortunately, many of the comments related to things that I had just copied over from your guide and planned to rework.

The part of the PR that is now ready to review is Part 1 indocs/hello_nextflow/seqera/01_run_with_cli.md.

I sketched out the outline of what I plan to do for Parts 2-4 in the following files:

  • "docs/hello_nextflow/seqera/02_run_with_launchpad.md"

  • "docs/hello_nextflow/seqera/03_add_compute_environment.md"

  • "docs/hello_nextflow/seqera/04_setup_launchpad.md"

I'm about to head to the airport, but if you have time to review part 1 and/or open a PR into this branch that moves content from 10_seqera.md into the new structure I've outlined that would be much appreciated. <3

Copy link
Collaborator

@pinin4fjords pinin4fjords left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comments on part 1, just a suggestion about how the config stuff is described.

Boarding plane now, will try more later if I can :-)

docs/hello_nextflow/seqera/01_run_with_cli.md Outdated Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Outdated Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Outdated Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Outdated Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Outdated Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Outdated Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Outdated Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Outdated Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Outdated Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Outdated Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Show resolved Hide resolved
Copy link
Member Author

@kenibrewer kenibrewer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is ready for review. I decided to stop after the first two sections as the "simulated slurm tower agent" idea I had for a hands-on teaching of compute environments just didn't seem right once I wrote it up. (It's stashed in #420 ).

For now, let's get these two sections in and come back later to that idea after we figure out how to run slum, grid engine or some other executor within a devcontainer.

docs/hello_nextflow/seqera/01_run_with_cli.md Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Outdated Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Outdated Show resolved Hide resolved
docs/hello_nextflow/10_hello_seqera.md Show resolved Hide resolved
docs/hello_nextflow/10_hello_seqera.md Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Outdated Show resolved Hide resolved
@kenibrewer kenibrewer marked this pull request as ready for review October 27, 2024 22:48
Copy link
Collaborator

@vdauwera vdauwera left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the flow a lot, feels just right in terms of continuity with the previous parts. There are a few explanations that I felt could be clarified a little but I'm totally ok leaving that for an ulterior round. I didn't test it in practice yet but (what could possibly go wrong) it all seems really solid. Big thumbs up from me.

docs/hello_nextflow/seqera/01_run_with_cli.md Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Outdated Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Outdated Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Outdated Show resolved Hide resolved
docs/hello_nextflow/seqera/01_run_with_cli.md Show resolved Hide resolved
Copy link
Member

@mribeirodantas mribeirodantas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, Ken! I left a few suggestions/comments.

Co-authored by: Geraldine Van der Auwera <[email protected]>
Co-authored by: Marcel Ribeiro-Dantas <[email protected]>
@kenibrewer kenibrewer merged commit e10d1eb into dev Oct 28, 2024
8 checks passed
@kenibrewer kenibrewer deleted the feat/hello-seqera branch October 28, 2024 00:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants