millironx/nf-configs
1
0
Fork 0
mirror of https://github.com/MillironX/nf-configs.git synced 2024-11-22 08:29:54 +00:00
Code Issues Releases Packages Activity

Added pipeline-specific config files

Browse source
This commit is contained in:
ameynert 2021-03-18 12:55:03 +00:00 committed by GitHub
parent af6a6b1060
commit b48136a62e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/eddie.md
View file

@ -14,7 +14,7 @@ This will download and launch the [`eddie.config`](../conf/eddie.config) which h
The configuration file supports running nf-core pipelines with Docker containers running under Singularity by default. Conda is not currently supported. The configuration file supports running nf-core pipelines with Docker containers running under Singularity by default. Conda is not currently supported.
```bash ```bash
nextflow run nf-core/PIPELINE -profile eddie # ..rest of pipeline flags nextflow run nf-core/PIPELINE -profile eddie # ...rest of pipeline flags
``` ```
Before running the pipeline you will need to install Nextflow or load it from the module system. Generally the most recent version will be the one you want. Before running the pipeline you will need to install Nextflow or load it from the module system. Generally the most recent version will be the one you want.
@ -33,6 +33,14 @@ module load igmm/apps/nextflow
This config enables Nextflow to manage the pipeline jobs via the SGE job scheduler and using Singularity for software management. This config enables Nextflow to manage the pipeline jobs via the SGE job scheduler and using Singularity for software management.
### Pipeline-specific config files
In addition to the generic nf-core configuration accessed via `-profile eddie`, there are pipeline-specific configuration files in the NextGenResources fileset to handle processes that are known to require specific custom configuration on the eddie system, in particular Java processes which require an extra memory overhead. For example:
```bash
nextflow run nf-core/rnaseq -profile eddie -c /exports/igmm/eddie/NextGenResources/nextflow/conf/eddie.rnaseq.config # ...rest of pipeline flags
```
## Singularity set-up ## Singularity set-up
Load Singularity from the module system and set the Singularity cache directory to the NextGenResources path for the pipeline and version you want to run. If this does not exist, please contact the [IGMM Data Manager](data.manager@igmm.ed.ac.uk) to have it added. You can add these lines to the file `$HOME/.bashrc`, or you can run these commands before you run an nf-core pipeline. Load Singularity from the module system and set the Singularity cache directory to the NextGenResources path for the pipeline and version you want to run. If this does not exist, please contact the [IGMM Data Manager](data.manager@igmm.ed.ac.uk) to have it added. You can add these lines to the file `$HOME/.bashrc`, or you can run these commands before you run an nf-core pipeline.