Skip to content

Commit e039f28

Browse files
authored
Merge pull request #139 from nf-core/docs_update
Further clarification on `--max-cpus`
2 parents df6305f + 45ce547 commit e039f28

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

docs/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ Use to set a top-limit for the default time requirement for each process.
237237
Should be a string in the format integer-unit. eg. `--max_time '2.h'`. If not specified, will be taken from the configuration in the `-profile` flag.
238238

239239
### `--max_cpus`
240-
Use to set a top-limit for the default CPU requirement for each process.
240+
Use to set a top-limit for the default CPU requirement for each **process**. This is not the maximum number of CPUs that can be used for the whole pipeline, but the maximum number of CPUs each program can use for each program submission (known as a process). Do not set this higher than what is available on your workstation or computing node can provide. If you're unsure, ask your local IT administrator for details on compute node capabilities!
241241
Should be a string in the format integer-unit. eg. `--max_cpus 1`. If not specified, will be taken from the configuration in the `-profile` flag.
242242

243243
### `--email`

0 commit comments

Comments
 (0)