sgather(1)

1SGATHER(1)                   ZIH Slurm extensions                   SGATHER(1)
2
3
4

NAME

6       sgather - transmit a file from the nodes allocated to a Slurm job.
7
8

SYNOPSIS

10       sgather [-rikCFpvV] SOURCE DEST
11
12

DESCRIPTION

14       sgather is used to transmit a file from all nodes allocated to the cur‐
15       rently active Slurm job. This command  should  only  be  executed  from
16       within  a  Slurm  batch  job  or within the shell spawned after a Slurm
17       job's resource allocation. SOURCE should be the fully  qualified  path‐
18       name  for  the file copy to be fetched from each node. SOURCE should be
19       on a file system local to that node. DEST is the name of the file to be
20       created  on  the  current  node  where  the  source  node  name will be
21       appended. Note that parallel file systems may  provide  better  perfor‐
22       mance  than sgather can provide, although performance will vary by file
23       size, degree of parallelism, and network type.
24
25

OPTIONS

27       -C, --compress
28              Compress the file being transmitted.
29
30       -f, --force
31              Ignore nonexistent source file.
32
33       -F number, --fanout=number
34              Specify the fanout of messages used for file transfer.   Maximum
35              value is currently eight.
36
37       -k, --keep
38              Do not remove the source file after transmission.
39
40       -p, --preserve
41              Preserves  modification  times, access times, and modes from the
42              original file.
43
44       -r, --recursive
45              Copy directories recursively.
46
47       -t seconds, --timeout=seconds
48              Specify the message timeout in seconds.  The default value is 60
49              seconds.
50
51       -v, --verbose
52              Provide detailed event logging through program execution.
53
54       -V, --version
55              Print version information and exit.
56
57

ENVIRONMENT VARIABLES

59       Some sgather options may be set via environment variables.  These envi‐
60       ronment variables, along with their corresponding options,  are  listed
61       below.  (Note:  Command  line  options  will always override these set‐
62       tings.)
63
64       SGATHER_COMPRESS    -C, --compress
65
66       SGATHER_FANOUT      -F number, --fanout=number
67
68       SGATHER_FORCE       -f, --force
69
70       SGATHER_KEEP        -k, --keep
71
72       SGATHER_PRESERVE    -p, --preserve
73
74       SGATHER_RECURSIVE   -r, --recursive
75
76       SGATHER_TIMEOUT     -t seconds, --timeout=seconds
77
78

EXAMPLE

80       Using a batch script, execute a program that produces  /tmp/my.data  on
81       all  nodes  allocated to the Slurm job and then transmit these files to
82       the batch node.
83
84       > cat my.job
85       #!/bin/bash
86       srun my.prog --output /tmp/my.data
87       sgather /tmp/my.data all_data
88
89       > sbatch --nodes=8 my.job
90       srun: jobid 12345 submitted
91
92

COPYING

94       Copyright (C) 2013-2013 ZIH, TU Dresden, Federal Republic of Germany.
95
96