Merge pull request #489 from brucemoran/UCD_SONIC

Ucd sonic

.github/workflows/main.yml

@@ -111,6 +111,7 @@ jobs:
           - "tubingen_apg"
           - "ucl_myriad"
           - "uct_hpc"
+          - "ucd_sonic"
           - "uge"
           - "unibe_ibu"
           - "uppmax"

README.md

@@ -164,6 +164,7 @@ Currently documentation is available for the following systems:
 - [Super Computing Wales](docs/scw.md)
 - [TIGEM](docs/tigem.md)
 - [TUBINGEN_APG](docs/tubingen_apg.md)
+- [UCD_SONIC](docs/ucd_sonic.md)
 - [UCL_MYRIAD](docs/ucl_myriad.md)
 - [UCT_HPC](docs/uct_hpc.md)
 - [UGE](docs/uge.md)

conf/ucd_sonic.config

@@ -0,0 +1,22 @@
+params {
+  config_profile_name = 'UCD_SONIC'
+  config_profile_description = 'University College Dublin Sonic HPC profile provided by nf-core/configs.'
+  config_profile_contact = 'Bruce Moran (@brucemoran)'
+  config_profile_url = 'https://www.ucd.ie/itservices/ourservices/researchit/researchcomputing/sonichpc/'
+  max_cpus = 40
+  max_time = 12.h
+}
+
+process {
+  executor = 'slurm'
+  queue = 'shared'
+  queueSize = 50
+  submitRateLimit = '10 sec'
+  maxRetries = 2
+  beforeScript = 'export NXF_OPTS="-Xms2G -Xmx40G"; module load nextflow/22.04.5.5708 singularity/3.5.2'
+  clusterOptions = { "--mem 1M" } 
+  cache = 'lenient'
+  memory = 1.MB
+}
+
+cleanup = true

docs/ucd_sonic.md

@@ -0,0 +1,17 @@
+# nf-core/configs: UCD Sonic Configuration
+
+The nf-core pipeline [sarek](https://nf-co.re/sarek) has been successfully tested on [Sonic HPC] (https://www.ucd.ie/itservices/ourservices/researchit/researchcomputing/sonichpc) using this config.
+
+This Sonic config offers very minimal options to users but should allow the use of all nf-core pipelines.
+
+## sbatch_nxf_creator
+
+To run a pipeline, you can optionally use the [sbatch_nxf_creator](https://github.com/brucemoran/sbatch_nxf_creator) method.
+
+This allows you to write a YAML file including all of your sample names that you want to process individually, as well as your basic Nextflow command and where the output should be written.
+
+There are some additional requirements on Sonic based on its use of SLURM which are resolved using this write this method.
+
+The `sbatch_nxf_creator.sh` parses your YAML and makes an `sbatch` file that can be submitted to the scheduler via a simple `sbatch my_file.sbatch` command.
+
+Practically, it means appending `srun` to the command and appending `-with-mpi`, as well as a few other vaguaries like specifying output and loading `Nextflow` and `Singularity`.

nfcore_custom.config

@@ -91,6 +91,7 @@ profiles {
     seg_globe        { includeConfig "${params.custom_config_base}/conf/seg_globe.config"}
     tigem            { includeConfig "${params.custom_config_base}/conf/tigem.config"}
     tubingen_apg     { includeConfig "${params.custom_config_base}/conf/tubingen_apg.config" }
+    ucd_sonic        { includeConfig "${params.custom_config_base}/conf/ucd_sonic.config"}
     ucl_myriad       { includeConfig "${params.custom_config_base}/conf/ucl_myriad.config"}
     uct_hpc          { includeConfig "${params.custom_config_base}/conf/uct_hpc.config" }
     uge              { includeConfig "${params.custom_config_base}/conf/uge.config" }