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

feat: update docs

Browse source
This commit is contained in:
MaxUlysse 2019-08-07 11:56:10 +02:00
parent 0bd19517b3
commit f69524d59a
1 changed files with 16 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/munin.md
View file

@ -2,16 +2,30 @@
All nf-core pipelines have been successfully configured for use on the MUNIN cluster. All nf-core pipelines have been successfully configured for use on the MUNIN cluster.
## Usage
To use, run the pipeline with `-profile munin`. To use, run the pipeline with `-profile munin`.
This will download and launch the [`munin.config`](../conf/munin.config) which has been pre-configured with a setup suitable for the MUNIN cluster. This will download and launch the [`munin.config`](../conf/munin.config) which has been pre-configured with a setup suitable for the MUNIN cluster.
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.
Example: `nextflow run -profile munin` Example: `nextflow run -profile munin`
## Docker ### Singularity
This is the default behavior of this configuration profile.
Using this profile, if no singularity image are available, one will be downloaded from dockerhub, and converted to a Singularity image before execution of the pipeline.
It is also possible to specify the singularity profile:
Example: `nextflow run -profile munin,singularity`
### Docker
It is also possible to execute the pipeline using Docker. It is also possible to execute the pipeline using Docker.
Using this profile, if no docker image are available, one will be downloaded from dockerhub before execution of the pipeline.
Example: `nextflow run -profile munin,docker` Example: `nextflow run -profile munin,docker`
## Below are non-mandatory information on iGenomes specific configuration ## Below are non-mandatory information on iGenomes specific configuration