You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/usage.md
+6-10Lines changed: 6 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -366,6 +366,10 @@ You can also generate such `YAML`/`JSON` files via [nf-core/launch](https://nf-c
366
366
367
367
### Running on Linux ARM architectures
368
368
369
+
:::warning
370
+
Please note that the ARM profile is experimental. It is expected to function correctly in all cases unless explicitly indicated otherwise—currently, exceptions include the use of the hisat2 aligner and contaminant screening via kraken2. However, because testing is presently conducted manually, we cannot guarantee its reliability.
371
+
:::
372
+
369
373
The pipeline can be executed in an ARM compatible mode by specifying the ARM profile, for example:
370
374
371
375
```bash
@@ -378,11 +382,7 @@ nextflow run \
378
382
-profile docker,arm
379
383
```
380
384
381
-
This will use ARM-compatible containers, and apply a small number of overrides to Conda definitions to support ARM operation.
382
-
383
-
:::warning
384
-
Please note that the ARM profile is experimental. It is expected to function correctly in all cases unless explicitly indicated otherwise—currently, exceptions include the use of the hisat2 aligner and contaminant screening via kraken2. However, because testing is presently conducted manually, we cannot guarantee its reliability.
385
-
:::
385
+
This will use ARM-compatible containers, and apply a small number of overrides to Conda definitions to support ARM operations.
386
386
387
387
### Updating the pipeline
388
388
@@ -449,11 +449,7 @@ If `-profile` is not specified, the pipeline will run locally and expect all sof
449
449
-`conda`
450
450
- A generic configuration profile to be used with [Conda](https://conda.io/docs/). Please only use Conda as a last resort i.e. when it's not possible to run the pipeline with Docker, Singularity, Podman, Shifter, Charliecloud, or Apptainer.
451
451
-`arm`
452
-
- A configuration profile that will set `docker.runOptions` appropriately for ARM architectures, and apply overrides supplying ARM-compatible containers and Conda environments.
453
-
454
-
:::warning
455
-
Please note that the ARM profile is experimental. It is expected to function correctly in all cases unless explicitly indicated otherwise—currently, exceptions include the use of the hisat2 aligner and contaminant screening via kraken2. However, because testing is presently conducted manually, we cannot guarantee its reliability.
456
-
:::
452
+
- A configuration profile that will set `docker.runOptions` appropriately for ARM architectures, and apply overrides supplying ARM-compatible containers and Conda environments. See [Running on Linux ARM architectures](#running-on-linux-arm-architectures).
0 commit comments