Skip to content

Commit 755149e

Browse files
committed
Describe profile 'large' in Readme
1 parent 2eb2d01 commit 755149e

1 file changed

Lines changed: 13 additions & 3 deletions

File tree

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,8 @@ For FastOMA, we've implemented the following profiles below. Additional ones can
186186
With `-profile docker` one can use docker as an execution platform. It requires docker to be installed on the system (see [here](https://docs.docker.com/engine/install/)). The pipeline
187187
will automatically fetch missing containers from dockerhub (e.g. dessimozlab/fastoma) if not found locally. By default, the version
188188
`latest` is used by the pipeline, however we provide images for any branch and release as well; even for every recent commit.
189-
One can select the desired container via the `--container_version` argument
189+
One can select the desired container via the `--container_version` argument. We provide containers for x86_64 (amd64) as well
190+
as arm64 architectures.
190191

191192
```
192193
nextflow run FastOMA.nf -profile docker \
@@ -197,7 +198,7 @@ nextflow run FastOMA.nf -profile docker \
197198
This will use the container that is tagged with the current commit id. Similarly, one could also use
198199
`--container_version "0.5.1"` to use the container with version `dessimozlab/fastoma:0.5.1` from dockerhub. Check the latest version on the [DockerHub](https://hub.docker.com/r/dessimozlab/fastoma/tags).
199200

200-
### Singularity
201+
### Singularity / Apptainer
201202
Since Docker needs administrator privileges (root access), [Singluarity](https://apptainer.org/index.html) (a.k.a Apptainer) is a good alternative. This can be installed using [Conda](https://anaconda.org/conda-forge/singularity) with `conda install conda-forge::singularity`. However, in most of the academic HPC cluster, singluarity is already installed and can be called with `module load`.
202203
With `-profile singularity` singularity containers will be used to run the workflow. It requires singularity to
203204
be installed on your system. The containers are automatically pulled from dockerhub and converted to singularity
@@ -223,6 +224,13 @@ specify it with the `-c <path_to_profile_file>` argument. The nf-core profiles s
223224
good overview of what is possible, together with the
224225
[nextflow documentation on executors](https://www.nextflow.io/docs/latest/executor.html).
225226

227+
### Large datasets
228+
Another profile we provide is `-profile large` which is designed for large datasets. It sets much higher limits for the
229+
maximum amount of memory a process can use (without specifying this profile, jobs will not try to request more than 32 GB
230+
of RAM).
231+
232+
All profiles can be combined, e.g. `-profile slurm,conda,large`.
233+
226234

227235
# How to run FastOMA on the test data
228236
Note : If you are using FastOMA with Docker or other profiles, check out the difference [here](#using-different-nextflow-profiles).
@@ -413,7 +421,9 @@ Let's save the planet together with
413421

414422

415423
### Run on a cluster
416-
For running on a SLURM cluster, you can add the slurm profile argument: `-profile slurm` to the command line.
424+
For running on a SLURM cluster, you can add the slurm profile argument: `-profile slurm` to the command line.
425+
We also recommend to use the singularity/apptainer container, which can be enabled by adding the `singularity` or `apptainer` profile:
426+
`-profile slurm,singularity` or `-profile slurm,apptainer`.
417427

418428
```
419429
# cd FastOMA/testdata

0 commit comments

Comments
 (0)