1
0
Fork 0
mirror of https://github.com/MillironX/nf-configs.git synced 2024-12-04 12:39:55 +00:00
nf-configs/docs/ku_sund_dangpu.md

36 lines
1.7 KiB
Markdown
Raw Normal View History

2022-07-06 11:35:10 +00:00
# nf-core/configs: ku_sund_dangpu configuration
2022-07-05 10:05:10 +00:00
2022-09-22 12:21:02 +00:00
All nf-core pipelines have been successfully configured for use on the DANGPU at the
2022-07-05 10:05:10 +00:00
Novo Nordisk Foundation Center for Stem Cell Medicine (reNEW) and the Novo Nordisk Foundation Center for Protein Research (CPR) at the University of Copenhagen.
2022-07-06 07:52:06 +00:00
To use, run the pipeline with `-profile ku_sund_dangpu`. This will download and launch the [`ku_sund_dangpu.config`](../conf/ku_sund_dangpu.config) which has been pre-configured with a setup suitable for the DANGPU.
2022-07-05 10:05:10 +00:00
## Modules
2022-07-06 07:52:06 +00:00
Before running the pipeline you will need to load Nextflow and Singularity using the environment module system on DANGPU. You can do this by issuing the commands below:
2022-07-05 10:05:10 +00:00
```bash
## Load Nextflow and Singularity environment modules
module purge
module load java/11.0.15 nextflow/22.04.4 singularity/3.8.0
# alternative modules for older nextflow version (v.21) that works with java 8:
2022-09-22 12:21:02 +00:00
# module load jdk/1.8.0_291 nextflow/21.04.1.5556 singularity/3.8.0
2022-07-05 10:05:10 +00:00
export NXF_OPTS='-Xms1g -Xmx4g'
2022-07-06 07:52:06 +00:00
export NXF_HOME=/projects/dan1/people/${USER}/cache/nxf-home
export NXF_TEMP=/scratch/tmp
2022-09-22 12:21:02 +00:00
export NXF_SINGULARITY_CACHEDIR=/projects/dan1/people/${USER}/cache/singularity-images
2022-07-05 10:05:10 +00:00
```
2022-07-06 14:19:16 +00:00
Create the user-specific nextflow directories if they don't exist yet:
2022-09-22 12:21:02 +00:00
2022-07-05 10:05:10 +00:00
```
mkdir $NXF_SINGULARITY_CACHEDIR
mkdir $NXF_HOME
```
2022-09-22 12:21:02 +00:00
Finally, download and test the pipeline of choice using the `-profile ku_sund_dangpu`. Note that normally you would run resource-intensive commands with slurm, but in case of nf-core pipelines you do not have to do this: we have pre-configured slurm to be the resource manager within the `ku_sund_dangpu profile`. Just make sure that the pipeline is run within a tmux session.
2022-07-06 10:54:07 +00:00
2022-07-05 10:05:10 +00:00
```
2022-07-05 10:06:19 +00:00
nextflow run nf-core/rnaseq -profile test,ku_sund_dangpu
2022-07-05 10:05:10 +00:00
```