-
Notifications
You must be signed in to change notification settings - Fork 356
Revise documentation for Imperial CX3 HPC Configuration #991
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
davidhemp
wants to merge
4
commits into
nf-core:master
Choose a base branch
from
davidhemp:patch-1
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,20 @@ | ||
| # nf-core/configs: Imperial CX1 HPC Configuration | ||
| # nf-core/configs: Imperial CX3 HPC Configuration | ||
|
|
||
| All nf-core pipelines have been successfully configured for use on the CX1 cluster at Imperial College London HPC. | ||
| All nf-core pipelines have been successfully configured for use on the CX3 cluster at Imperial College London HPC. | ||
|
|
||
| To use, run the pipeline with `-profile imperial,standard`. This will download and launch the [`imperial.config`](../conf/imperial.config) which has been pre-configured with a setup suitable for the CX1 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. | ||
| To use, run the pipeline with `-profile imperial,standard`. This will download and launch the [`imperial.config`](../conf/imperial.config) which has been pre-configured with a setup suitable for the CX3 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. | ||
|
|
||
| Before running the pipeline you will need to load Nextflow using the environment module system on the CX1 cluster. You can do this by issuing the commands below: | ||
| Before running the pipeline you will need to install Nextflow into a conda environment. The instructions below at taken from the [`RCS guidance on using conda`](https://icl-rcs-user-guide.readthedocs.io/en/latest/hpc/applications/guides/conda/) | ||
|
|
||
| ```bash | ||
| ## Load Nextflow and Singularity environment modules | ||
| module load anaconda3/personal | ||
| conda install -c bioconda nextflow | ||
| module load miniforge/3 | ||
| miniforge-setup | ||
| eval "$(~/miniforge3/bin/conda shell.bash hook)" | ||
| conda create -n nextflow -c bioconda nextflow | ||
| ``` | ||
|
|
||
| > NB: You will need an account to use the HPC cluster CX1 in order to run the pipeline. If in doubt contact IT. | ||
| > NB: Nextflow will need to submit the jobs via the job scheduler to the HPC cluster and as such the commands above will have to be executed on one of the login nodes. If in doubt contact IT. | ||
| > NB: You will need an Imperial account to use any HPC cluster managed by the RCS team. If in doubt contact the [`RCS team`](https://icl-rcs-user-guide.readthedocs.io/en/latest/support/) | ||
| > NB: Nextflow will need to submit the jobs via the job scheduler to the HPC cluster and as such the commands above will have to be executed on one of the login nodes. | ||
| > NB: To submit jobs to the Imperial College MEDBIO cluster, use `-profile imperial,medbio` instead. | ||
| > NB: You will need a restricted access account to use the HPC cluster MEDBIO. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.