Skip to content

Commit 896dd74

Browse files
committed
[skip ci] Reorg ARM bits
1 parent d4fcb56 commit 896dd74

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

docs/usage.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -366,6 +366,10 @@ You can also generate such `YAML`/`JSON` files via [nf-core/launch](https://nf-c
366366

367367
### Running on Linux ARM architectures
368368

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+
369373
The pipeline can be executed in an ARM compatible mode by specifying the ARM profile, for example:
370374

371375
```bash
@@ -378,11 +382,7 @@ nextflow run \
378382
-profile docker,arm
379383
```
380384

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.
386386

387387
### Updating the pipeline
388388

@@ -449,11 +449,7 @@ If `-profile` is not specified, the pipeline will run locally and expect all sof
449449
- `conda`
450450
- 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.
451451
- `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).
457453

458454
### `-resume`
459455

0 commit comments

Comments
 (0)