Merge pull request #266 from RoganGrant/master

Northwestern University Genomics Nodes (new add)

.github/workflows/main.yml

@@ -48,6 +48,7 @@ jobs:
             - 'lugh'
             - 'mpcdf'
             - 'munin'
+            - 'nu_genomics'
             - 'oist'
             - 'pasteur'
             - 'phoenix'

README.md

@@ -117,6 +117,7 @@ Currently documentation is available for the following systems:
 * [LUGH](docs/lugh.md)
 * [MPCDF](docs/mpcdf.md)
 * [MUNIN](docs/munin.md)
+* [NU_GENOMICS](docs/nu_genomics.md)
 * [OIST](docs/oist.md)
 * [PASTEUR](docs/pasteur.md)
 * [PHOENIX](docs/phoenix.md)

conf/nu_genomics.config

@@ -0,0 +1,30 @@
+//Profile config names for nf-core/configs
+params
+{
+  config_profile_description = 'Northwestern University Quest HPC (Genomics Nodes) config provided by nf-core/configs'
+  config_profile_contact = 'Rogan Grant / Janna Nugent (@RoganGrant, @NUjon)'
+  config_profile_url = 'https://www.it.northwestern.edu/research/user-services/quest/'
+  max_memory = 190.GB
+  max_cpus = 40
+  max_time = 240.h
+  igenomes_base = "/projects/genomicsshare/AWS_iGenomes/references"
+}
+
+singularity
+{
+  enabled = true
+  cacheDir = "/projects/b1042/singularity_cache"
+}
+
+process
+{
+  beforeScript = 'module purge; module load singularity/latest; module load graphviz/2.40.1'
+  executor = 'slurm'
+  queue = {task.memory >= 190.GB ? 'genomics-himem' : task.time >= 48.h ? 'genomicslong' : 'genomics'}
+  clusterOptions = '-A b1042'
+}
+
+executor
+{
+  submitRateLimit = '1sec'
+}

docs/nu_genomics.md

@@ -0,0 +1,35 @@
+# nf-core/configs: NU_Genomics Configuration
+
+All nf-core pipelines have been successfully configured for use on the Quest Genomics Nodes at Northwestern University. Note that, at present, this config has only been tested with nf-core/RNA-seq, but should function similarly for other nf-core pipelines. If you would like to test other pipelines and share on the genomics-rcs Slack, we would be very much obliged.
+
+To use, run the pipeline with `-profile nu_genomics`. This will download and launch the [`nu_genomics.config`](../conf/nu_genomics.config) which has been pre-configured with a setup suitable for the Quest Genomics Nodes. Using this profile, a docker image containing all of the required software will be downloaded, and converted to a Singularity image before execution of the pipeline.
+
+## Before running the pipeline
+
+There are several important steps to take before this pipeline will run successfully on Quest. First, you must have an active Quest allocation. If you do not, please apply [here](https://www.it.northwestern.edu/secure/forms/research/allocation-request.html). You will also need access to the Genomics Nodes. If you do not already have access, please apply [here](https://app.smartsheet.com/b/form?EQBCT=9b3647a8cb2145929737ab4a0540cb46). Finally, you will need to perform a local installation of Nextflow and add it to your path. Please follow the basic installation instructions shown [here](https://www.nextflow.io/), or install in your home directory as shown. If you already have a bin directory in your path, you will not need to create the directory or append to your path.
+
+```bash
+cd ~
+mkdir bin
+cd bin
+curl -s https://get.nextflow.io | bash
+export PATH=~/bin:$PATH
+```
+
+Note that you may need to install an "edge" version of Nextflow, depending on which pipeline you use. Please read the documentation carefully to see if this is the case, or you may see an error when running the pipeline. If this is the case, you need to explicitly set the version when installing, e.g.:
+
+```bash
+curl -s https://github.com/nextflow-io/nextflow/releases/download/v20.11.0-edge/nextflow-20.11.0-edge-all | bash
+```
+
+Note that while the config does explicitly load the necessary modules, you will often need to load them manually anyway. Please do so before each run as follows, or you may run into errors:
+
+```bash
+module purge
+module load singularity/latest
+module load graphviz/2.40.1
+```
+
+## Use of iGenomes
+
+A local copy of the iGenomes resource with all commonly used genomes has been made available for all of Quest so you should be able to run the pipeline against any reference available in the `igenomes.config` specific to the nf-core pipeline. These files can be found at `/projects/genomicsshare/AWS_iGenomes`. You can do this by simply using the `--genome <GENOME_ID>` parameter. While you can technically "stream" genomes from iGenomes directly using the pipeline, this is a substantial use of bandwidth and resources on both ends, and potentially poses reproducibility issues later on. Please use the local copies unless absolutely necessary, and save your custom genomes to your personal allocation where necessary.

nfcore_custom.config

@@ -42,6 +42,7 @@ profiles {
   lugh         { includeConfig "${params.custom_config_base}/conf/lugh.config" }
   mpcdf        { includeConfig "${params.custom_config_base}/conf/mpcdf.config" }
   munin        { includeConfig "${params.custom_config_base}/conf/munin.config" }
+  nu_genomics  { includeConfig "${params.custom_config_base}/conf/nu_genomics.config" }
   oist         { includeConfig "${params.custom_config_base}/conf/oist.config" }
   pasteur      { includeConfig "${params.custom_config_base}/conf/pasteur.config" }
   phoenix      { includeConfig "${params.custom_config_base}/conf/phoenix.config" }