Skip to content

Commit

Permalink
added docs for pipeline specific configs
Browse files Browse the repository at this point in the history
  • Loading branch information
husensofteng committed Jan 13, 2025
1 parent 06c0d39 commit d9ef9d5
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/kaust.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ This will download and launch the [`kaust.config`](../conf/kaust.config) which h
It will enable `Nextflow` to manage the pipeline jobs via the `Slurm` job scheduler and `Singularity` to run the tasks.
Using the KAUST profile, `Docker` image(s) containing required software(s) will be downloaded, and converted to `Singularity` image(s) if needed before execution of the pipeline. To avoid downloading same images by multiple users, we provide a singularity `libraryDir` that is configured to use images already downloaded in our central container library. Images missing from our library will be downloaded to the user's directory as defined by `cacheDir`.

Additionally, institute-specific pipeline profiles exists for:

- mag
- rnaseq


### Accessing reference genomes on Ibex

We provide a collection of reference genomes, enabling users to run workflows seamlessly without needing to download the files. To enable access to this resource, simply add the `includeConfig` line in the script below to a `nextflow.config` file under the launch directory.
Expand Down
15 changes: 15 additions & 0 deletions docs/pipeline/mag/kaust.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# nf-core/configs: kaust mag specific configuration

Extra specific configuration for [nf-co.re/mag](https://nf-co.re/mag) pipeline

## Usage

To use, run the pipeline with `-profile kaust`.

This will download and launch the mag specific [`kaust.config`](../../../conf/pipeline/mag/kaust.config) which has been pre-configured with a setup suitable for the Ibex cluster.

Example: `nextflow run nf-core/mag -profile kaust`

## mag specific configurations for kaust

Specific configurations for kaust has been made for mag, primarily increasing the default resource allocations especeially for high demand processes.
15 changes: 15 additions & 0 deletions docs/pipeline/rnaseq/kaust.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# nf-core/configs: kaust rnaseq specific configuration

Specific configuration for [nf-co.re/rnaseq](https://nf-co.re/rnaseq) pipeline

## Usage

To use, run the pipeline with `-profile kaust`.

This will download and launch the rnaseq specific [`kaust.config`](../../../conf/pipeline/rnaseq/kaust.config) which has been pre-configured with a setup suitable for the Ibex cluster.

Example: `nextflow run nf-core/rnaseq -profile kaust`

## rnaseq specific configurations for kaust

Specific configurations for kaust has been made for rnaseq, primarily increasing the default resource allocations especeially for high demand processes.

0 comments on commit d9ef9d5

Please sign in to comment.