Skip to content

Commit 9d39ad4

Browse files
committed
update comment for TCS Executor
Signed-off-by: Satoshi Ohshima <[email protected]>>
1 parent d30c74e commit 9d39ad4

File tree

2 files changed

+40
-29
lines changed

2 files changed

+40
-29
lines changed

Diff for: docs/executor.md

+39
Original file line numberDiff line numberDiff line change
@@ -473,3 +473,42 @@ Nextflow does not provide direct support for SLURM multi-clusters. If you need t
473473
:::{versionadded} 23.07.0-edge
474474
Some SLURM clusters require memory allocations to be specified with `--mem-per-cpu` instead of `--mem`. You can specify `executor.perCpuMemAllocation = true` in the Nextflow configuration to enable this behavior. Nextflow will automatically compute the memory per CPU for each task (by default 1 CPU is used).
475475
:::
476+
477+
## TCS
478+
479+
The `tcs` executor allows you to run your pipeline script using a [Fujitsu Technical Computing Suite (TCS)](https://software.fujitsu.com/jp/manual/manualindex/p21000155e.html).
480+
481+
Nextflow manages each process as a separate job that is submitted to the cluster using the `pjsub` command.
482+
483+
The pipeline must be launched from a node where the `pjsub` command is available, which is typically the login node.
484+
485+
To enable the TCS executor, set `process.executor = 'tcs'` in the `nextflow.config` file.
486+
487+
Resource requests and other job characteristics can be controlled via the following process directives:
488+
489+
- {ref}`process-clusterOptions`
490+
- {ref}`process-time`
491+
492+
:::{note}
493+
Other options such as queue (resource group), cpu, and node should be indicated by clusterOptions.
494+
This is because they depend on target systems (required options are not the same) and can be controlled by "-L" options in arguments of pjsub command.
495+
496+
This is an example of nextflow.config on Supercomputer Genkai (Kyushu University).
497+
```
498+
process {
499+
executor = 'tcs'
500+
time = '00:30:00'
501+
clusterOptions = '-L rscgrp=a-batch -L vnode-core=4'
502+
}
503+
```
504+
505+
This is an example of nextflow.config on Supercomputer Flow (Nagoya University).
506+
```
507+
process {
508+
executor = 'tcs'
509+
time = '00:30:00'
510+
clusterOptions = '-L rscunit=cx -L rscgrp=cx-share -L gpu=1'
511+
}
512+
```
513+
514+
(tcs-executor)=

Diff for: modules/nextflow/src/main/groovy/nextflow/executor/TcsExecutor.groovy

+1-29
Original file line numberDiff line numberDiff line change
@@ -11,30 +11,6 @@
1111
* See the License for the specific language governing permissions and
1212
* limitations under the License.
1313
*/
14-
/*
15-
Implemented by Satoshi Ohshima <[email protected]>
16-
I referred to the other executors groovy implementations.
17-
Resource requests and other job characteristics can be controlled via the following process directives:
18-
- time
19-
- clusterOptions
20-
queue (resource group), cpu, node, and other options should be indicated by clusterOptions.
21-
This is because they depend on target systems (required options are not the same) and can be controlled by "-L" options in arguments of pjsub command.
22-
23-
example of nextflow.config on Genkai (Kyushu University)
24-
process {
25-
executor = 'tcs'
26-
time = '00:30:00'
27-
clusterOptions = '-L rscgrp=a-batch -L vnode-core=4'
28-
}
29-
30-
example of nextflow.config on Flow (Nagoya University)
31-
process {
32-
executor = 'tcs'
33-
time = '00:30:00'
34-
clusterOptions = '-L rscunit=cx -L rscgrp=cx-share -L gpu=1'
35-
}
36-
37-
*/
3814

3915
package nextflow.executor
4016

@@ -45,11 +21,7 @@ import groovy.transform.CompileStatic
4521
import groovy.util.logging.Slf4j
4622
import nextflow.processor.TaskArrayRun
4723
import nextflow.processor.TaskRun
48-
/*
49-
* Implements a executor for Fujitsu TCS
50-
*
51-
* See https://software.fujitsu.com/jp/manual/manualindex/p21000154.html (in Japanese)
52-
*/
24+
5325
@Slf4j
5426
@CompileStatic
5527
class TcsExecutor extends AbstractGridExecutor implements TaskArrayExecutor {

0 commit comments

Comments
 (0)