-
Notifications
You must be signed in to change notification settings - Fork 55
Add documentation for running without Internet access #389
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
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
f8a7ee8
Add documentation about running offline
fa2k d6e7394
Use the correct name for new container system
fa2k 7bdd5d8
Correct typo
fa2k f3deb8d
Point to the documentation to download Nextflow
fa2k eaa4ca5
Removed the example and rephrased for clarity
fa2k 6304e71
Spelling configuration
fa2k f610855
Merge branch 'dev' into doc-offline
ramprasadn 35e1fe4
Merge branch 'dev' into doc-offline
fa2k c061a04
Merge branch 'dev' into doc-offline
ramprasadn 71739d6
Merge branch 'dev' into doc-offline
fa2k b201395
Merge branch 'dev' into doc-offline
ramprasadn 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -395,3 +395,24 @@ 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). 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](https://nf-co.re/docs/usage/offline#nextflow) on the page linked above, it is not possible to use the "-all" packaged version of Nextflow for this pipeline. The online version of Nextflow is necessary to support the necessary nextflow plugins. 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: | ||
|
|
||
| ``` | ||
| ./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 Nextflow confgiguration file, specified with `-c <YOURCONFIG>` when running the pipeline. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.