-
Notifications
You must be signed in to change notification settings - Fork 350
Newcastle #961
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
Open
chriswyatt1
wants to merge
19
commits into
nf-core:master
Choose a base branch
from
chriswyatt1:newcastle
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+171
−0
Open
Newcastle #961
Changes from 16 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
9d46ee9
Newcastle_dry_run
chriswyatt1 bafb697
Update newcastle.config
chriswyatt1 880753d
Update newcastle.config
chriswyatt1 0516b1d
Instructions to download nextflow
chriswyatt1 38b37c0
Merge branch 'nf-core:master' into newcastle
chriswyatt1 328c03a
Update Newcastle HPC cluster profile details
chriswyatt1 db53f98
Clarify config parameters in newcastle.config
chriswyatt1 e28cf86
Update Newcastle config with new parameters and cleanup
chriswyatt1 9ddbfe0
limit queue size
chriswyatt1 b057c81
Enhance Newcastle HPC configuration documentation
chriswyatt1 2e22da1
Update container system references to Apptainer
chriswyatt1 58c2636
Add error strategy for task exit status handling as per nf-core
chriswyatt1 2e597e6
Update newcastle.md
chriswyatt1 c3dea1d
Update example command for nextflow
chriswyatt1 5eaec58
Update newcastle.config
chriswyatt1 83ce112
Merge branch 'nf-core:master' into newcastle
chriswyatt1 9ec8ebe
Update newcastle.config
chriswyatt1 142030f
Update newcastle.md
chriswyatt1 65949ea
Update newcastle.md
chriswyatt1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -143,6 +143,7 @@ jobs: | |
| - "mssm" | ||
| - "munin" | ||
| - "nci_gadi" | ||
| - "newcastle" | ||
| - "nu_genomics" | ||
| - "nygc" | ||
| - "nyu_hpc" | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| params { | ||
| config_profile_description = 'Newcastle comet HPC cluster profile' | ||
| config_profile_contact = 'Chris Wyatt (@chriswyatt1)' | ||
| config_profile_url = '' | ||
chriswyatt1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| account = System.getenv('USER') | ||
| } | ||
|
|
||
| process { | ||
| executor = 'slurm' | ||
| scratch = true | ||
| errorStrategy = { task.exitStatus in ((130..145) + 104 + 175) ? 'retry' : 'finish' } | ||
| resourceLimits = [ | ||
| memory: 256.GB, | ||
| cpus: 32, | ||
| time: 48.h | ||
| ] | ||
| clusterOptions = { | ||
| def opts = [] | ||
| if (params.account) { | ||
| opts << "--account=${params.account}" | ||
| } | ||
| return opts.join(' ') | ||
| } | ||
| } | ||
|
|
||
| executor { | ||
| queueSize = 100 | ||
| } | ||
|
|
||
| singularity { | ||
| enabled = true | ||
| pullTimeout = '2 h' | ||
| autoMounts = true | ||
| } | ||
|
|
||
| cleanup = true | ||
|
|
||
| profiles { | ||
| debug { | ||
| cleanup = false | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| # nf-core/configs: Newcastle HPC Configuration | ||
|
|
||
| Configuration for the Newcastle University HPC cluster (Slurm scheduler). | ||
chriswyatt1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## ⚠️ Important usage note | ||
|
|
||
| **Do not run Nextflow on the login/head node.** | ||
|
|
||
| All nf-core pipelines must be launched **from within a Slurm job** using `sbatch`. Running on the login node can overload shared resources and may result in your job being terminated. See Submit the Job section. | ||
|
|
||
| ## Setup | ||
|
|
||
| ### 1. Load Java | ||
|
|
||
| Nextflow requires Java. On Newcastle HPC: | ||
|
|
||
| module load Java/17.0.6 | ||
|
|
||
| To make this persistent, add it to your `~/.bash_profile`: | ||
|
|
||
| # Load Java for Nextflow | ||
| module load Java/17.0.6 | ||
|
|
||
| ### 2. Install Nextflow | ||
|
|
||
| Install Nextflow using the official method: | ||
|
|
||
| curl -s https://get.nextflow.io | bash | ||
| chmod +x nextflow | ||
|
|
||
| Move it to a directory in your `$PATH`: | ||
|
|
||
| mkdir -p $HOME/bin | ||
| mv nextflow $HOME/bin/ | ||
|
|
||
| Ensure `$HOME/bin` is in your `PATH` (add to `~/.bash_profile` if needed): | ||
|
|
||
| export PATH="$HOME/bin:$PATH" | ||
|
|
||
| ### 3. Container system (Apptainer) | ||
|
|
||
| nf-core pipelines use containers for reproducibility. | ||
|
|
||
| On comet, **Apptainer (formerly Singularity)** is already installed. Check with: | ||
|
|
||
| module avail apptainer | ||
|
|
||
| Then load it (example): | ||
|
|
||
| module load Apptainer | ||
|
|
||
| ## Running pipelines | ||
|
|
||
| ### 1. Create a Slurm submission script | ||
|
|
||
| Create a file, e.g. `run_nfcore.sh`: | ||
|
|
||
| #!/bin/bash | ||
| #SBATCH --job-name=nfcore_run | ||
| #SBATCH --account=YOUR_ACCOUNT | ||
| #SBATCH --time=24:00:00 | ||
| #SBATCH --cpus-per-task=4 | ||
| #SBATCH --mem=8G | ||
|
|
||
| module load Java/17.0.6 | ||
| module load Apptainer | ||
|
|
||
| nextflow run nf-core/_pipeline_ \ | ||
| -profile newcastle \ | ||
| --account YOUR_ACCOUNT \ | ||
| --outdir results \ | ||
| -resume | ||
|
|
||
| ### 2. Submit the job | ||
|
|
||
| sbatch run_nfcore.sh | ||
|
|
||
| ## Configuration options | ||
|
|
||
| ### `--account` | ||
|
|
||
| You **must** provide a Slurm account when running: | ||
|
|
||
| --account YOUR_PROJECT_CODE | ||
|
|
||
| This is passed to Slurm as: | ||
|
|
||
| #SBATCH --account=YOUR_PROJECT_CODE | ||
|
|
||
| ## Example command to test nextflow is working (run this command, it should work!) | ||
|
|
||
| Inside your Slurm script: | ||
|
|
||
| nextflow run nf-core/fetchngs \ | ||
| -profile newcastle,test \ | ||
| --account bioinf_project \ | ||
| --outdir results \ | ||
| -resume | ||
|
|
||
| ## Example "real" command (will not work, just for demonstration) | ||
|
|
||
| nextflow run nf-core/rnaseq \ | ||
| -profile newcastle \ | ||
| --account bioinf_project \ | ||
| --input input_samplesheet.csv \ | ||
| --aligner hisat2 \ | ||
| --fasta mygenome.fasta \ | ||
| --gtf myannotation.gtf \ | ||
| --outdir results \ | ||
| -resume | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| - Jobs fail immediately → check `--account` is valid | ||
| - Nextflow not found → ensure `$HOME/bin` is in your `PATH` | ||
| - Container errors → ensure Apptainer module is loaded | ||
| - Jobs not starting → check Slurm queue limits (`squeue`, `sacct`) | ||
|
|
||
| ## Support | ||
|
|
||
| For issues with this configuration, please contact: | ||
|
|
||
| - Chris Wyatt (@chriswyatt1) Email: ecoflow.ucl@gmail.com | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.