-
Notifications
You must be signed in to change notification settings - Fork 34
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
Add documentation for running without Internet access #389
Changes from 1 commit
f8a7ee8
d6e7394
7bdd5d8
f3deb8d
eaa4ca5
6304e71
f610855
35e1fe4
c061a04
71739d6
b201395
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -393,3 +393,33 @@ We recommend adding the following line to your environment to limit this (typica | |||||
```bash | ||||||
NXF_OPTS='-Xms1g -Xmx4g' | ||||||
``` | ||||||
|
||||||
### Running the pipeline without Internet access | ||||||
|
||||||
The pipeline and container images can be downloaded using [nf-core tools](https://nf-co.re/docs/usage/offline). | ||||||
Here is an example command to download pipeline version 1.1.0 with singularity images: | ||||||
|
||||||
``` | ||||||
nf-core download \ | ||||||
--container singularity \ | ||||||
--compress none \ | ||||||
--revision 1.1.0 \ | ||||||
raredisease | ||||||
``` | ||||||
For running offline, you of course have to make all the reference data available locally, and specify `--fasta`, etc., see [above](#reference-files-and-parameters). | ||||||
|
||||||
Contrary to the paragraph about Nextflow on the nf-core tools page, it is not possible to use the "-all" packaged version of Nextflow. The online version of nextflow is necessary to support the nextflow plugins used for this pipeline. Download instead the file called just `nextflow`. Nextflow will download its dependencies when it is run. Additionally, you need to download the nf-validation plugin explicitly: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure which homepage and packages you are referring to there. Perhaps you mean https://nf-co.re/tools ? I didn't find any "paragraph about Nextflow" on https://nf-co.re/tools EDIT: Perhaps you're referring to https://nf-co.re/docs/usage/offline#nextflow ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've added another link, hope it makes sense like that |
||||||
|
||||||
``` | ||||||
./nextflow plugin install nf-validation | ||||||
``` | ||||||
|
||||||
Now you can transfer the `nextflow` binary as well as its directory `$HOME/.nextflow` to the system without Internet access, and use it there. It is necessary to use an explicit version of `nf-validation` offline, or Nextflow will check for the most recent version online. Find the version of nf-validation you downloaded in `$HOME/.nextflow/plugins`, then specify this version for `nf-validation` in your configuration file: | ||||||
|
||||||
``` | ||||||
plugins { | ||||||
// Set the plugin version explicitly, otherwise nextflow will look for the newest version online. | ||||||
id '[email protected]' | ||||||
} | ||||||
``` | ||||||
This should go in your Nexflow confgiguration file, specified with `-c <YOURCONFIG>` when running the pipeline. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
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.
When I run that command with the latest version of
nf-core
(v2.9), I get: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.
Sorry about that. Seems they have changed the CLI since I downloaded nf-core tools
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.
I would just refer to the general docs on the website
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.
Ok, makes sense. I will remove the example.