Skip to content

Commit 7866f92

Browse files
authored
Merge pull request #17 from jhlegarreta/AddNoteAboutNextflow
DOC: Add note about `nextflow`
2 parents aa91044 + 42cd2de commit 7866f92

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

source/installation/requirements.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ To use our Singularity container, you must install the `Singularity`_ package.
1010
Nextflow
1111
--------
1212

13+
Note that the below sections use ``nextflow`` version ``v19.04.0`` for
14+
illustrative purposes: newer versions might work or be required depending on the
15+
pipeline at issue.
16+
1317
Local Computer
1418
##############
1519
1. Before installing check your current version ``java -version``. If return something as ``java version "1.X"`` and X is 8 up to 11, you can skip this step else install java.
@@ -23,7 +27,7 @@ Local Computer
2327
High Performance computer (HPC)
2428
###############################
2529

26-
1. Try ```module load nixpkgs/16.09 module load java/1.8.0_192`` or check with your administrator or on the HPC website.
30+
1. Try ``module load nixpkgs/16.09 module load java/1.8.0_192`` or check with your administrator or on the HPC website.
2731
2. Use ``wget`` to install Nextflow, change the name, add execution rights and add the Nextflow path in the bash_profile.
2832

2933
::
@@ -32,6 +36,15 @@ High Performance computer (HPC)
3236
mv nextflow-19.04.0-all nextflow && \
3337
chmod +x nextflow && echo 'export PATH=$PATH:'$(pwd) >> ~/.bash_profile && source ~/.bash_profile
3438

39+
Note that a given HPC system might offer (a) readily available ``nextflow``
40+
version(s). If any of provided versions suffice for the pipeline at issue, the
41+
above step can be omitted, and reading the documentation of the HPC system is
42+
encouraged in order to load the suitable version. In the case of the Allianca
43+
Canada clusters, the above step might be substituted by adding the line
44+
``module load nextflow/19.04.0`` (depending on the desired and available
45+
versions) to the ``.bash_profile`` file and sourcing it.
46+
47+
3548
Singularity
3649
-----------
3750

0 commit comments

Comments
 (0)