1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
|
.TH run-escript 1 "" "" "esys Escript"
.SH NAME
run-escript - a launcher for programs and scripts using the escript libraries.
.SH SYNOPSIS
run-escript [-n
.I nn
] [-p
.I
np
] [-t
.I
nt
] [-f
.I
hostfile
] [-x ] [-V ] [-e ] [-h ] [-v ] [-o ] [-c ] [-i ] [-b ] [
.I
file
] [
.I
ARGS
]
.SH OPTIONS
.P
.I
file
is the name of a script,
.I ARGS
are arguments for the script.
.B escript
will import your current
environment variables. If no
.I
file
is given, then you will be given a python prompt (see -i for restrictions).
The options are used as follows:
.HP
.B
-n
.I
nn
Specify the number of compute nodes nn to be used.
This option overwrites the value of the
.B
ESCRIPT_NUM_NODES
environment variable. If
.I
nn
> 1 but escript was not compiled for MPI, then a warning is printed but execution is continued with
.I nn
= 1. The default value is 1.
.HP
.B
-p
.I np
Specify the number of MPI processes per node.
The total number of processes to be used is
.I
nn
times
.IR ns .
.\" Please put a dot here
This option overwrites the value of the
.B
ESCRIPT_NUM_PROCS
environment variable. If
.I
np
> 1 but escript is not compiled for MPI a warning
is printed but execution is continued with
.I
np
= 1. The default value is 1.
.HP
.B -t
.I nt
The number of threads used per processes. This option overwrites the value of the
.B
ESCRIPT_NUM_THREADS
environment variable. If
.I
nt
> 1 but escript is not compiled for OpenMP a warning is printed but execution is continued with
.I
nt
= 1. The default value is 1.
.HP
.B
-f
.I hostfile
Specify the name of a file with a list of host names. Some systems require to specify the addresses or names of
the compute nodes where MPI process should be spawned. The list of addresses or names of the compute
nodes is listed in the file with the name hostfile. In order to avoid oversubsription the number of different
hosts defined in hostfile must be equal to the number of requested compute nodes
.IR nn .
The option
overwrites the value of the
.B ESCRIPT HOSTFILE
environment variable. By default value no host file is
used.
.HP
.B
-c
Prints the information about the settings used to compile escript and stops execution.
.HP
.B
-V
Prints the version of escript and stops execution.
.HP
.B
-h
Prints a help message and stops execution.
.HP
.B
-i
Executes
.I
file
and switches to interactive mode after the execution is finished or an exception has
occurred. This option is useful for debugging a script. The option cannot be used if more than one process
(
.I
nn
*
.I
np
> 1) is used or if
.B
-b
is used.
.HP
.B
-b
Do not invoke python. This is used to run non-python programs.
.HP
.B
-e
Outputs export statements for the additional environment variables and commands used during escript execution. This option is useful if users wish to execute scripts without using the escript command.
.HP
.B
-o
Switches on the redirection of output of processors with MPI rank greater than zero to the files
"stdout_r.out" and "stderr_r.out" where
.I
r
is the rank of the processor. The option overwrites the value
of the
.B
ESCRIPT_CREATESTDFILES
environment variable.
.HP
.B
-v
Prints some diagonstic information.
|