Merge pull request #581 from ChristopherChristofi/create

add create.config

.github/workflows/main.yml

@@ -51,6 +51,7 @@ jobs:
           - "cfc_dev"
           - "cheaha"
           - "computerome"
+          - "create"
           - "crg"
           - "crick"
           - "crukmi"

README.md

@@ -108,6 +108,7 @@ Currently documentation is available for the following systems:
 - [CFC](docs/cfc.md)
 - [CHEAHA](docs/cheaha.md)
 - [Computerome](docs/computerome.md)
+- [CREATE](docs/create.md)
 - [CRG](docs/crg.md)
 - [CRICK](docs/crick.md)
 - [Cancer Research UK Manchester Institute](docs/crukmi.md)

conf/create.config

@@ -0,0 +1,17 @@
+params {
+    config_profile_description = "e-Research King's College London CREATE HPC"
+    config_profile_contact = "e-Research ([email protected])"
+    config_profile_url = "https://docs.er.kcl.ac.uk/"
+    max_memory = 1024.GB
+    max_cpus = 128
+    max_time = 48.h
+}
+
+singularity {
+    enabled = true
+    autoMounts = true
+}
+
+process {
+    executor = 'slurm'
+}

docs/create.md

@@ -0,0 +1,13 @@
+# nf-core/configs: CREATE HPC Configuration
+
+All nf-core pipelines have been successfully configured for use on the King's Computational Research, Engineering and Technology Environment (CREATE) HPC cluster at e-Research, King's College London.
+
+To use this profile, run the pipeline with `-profile create`. This will download and launch the [`create.config`](../conf/create.config) which has been pre-configured with a setup suitable for the CREATE HPC cluster.
+
+Before running the pipeline you will need to load Nextflow using the environment module system on CREATE HPC. You can do this with the following command:
+
+```bash
+module load nextflow
+```
+
+> NB: You will need an account to use the CREATE HPC cluster in order to run the pipeline. If in doubt contact IT.

nfcore_custom.config

@@ -32,6 +32,7 @@ profiles {
     cfc_dev          { includeConfig "${params.custom_config_base}/conf/cfc_dev.config" }
     cheaha           { includeConfig "${params.custom_config_base}/conf/cheaha.config" }
     computerome      { includeConfig "${params.custom_config_base}/conf/computerome.config" }
+    create           { includeConfig "${params.custom_config_base}/conf/create.config" }
     crg              { includeConfig "${params.custom_config_base}/conf/crg.config" }
     crick            { includeConfig "${params.custom_config_base}/conf/crick.config" }
     crukmi           { includeConfig "${params.custom_config_base}/conf/crukmi.config" }