/[escript]/branches/stage3.1/doc/manpage/man1/run-escript.1
ViewVC logotype

Contents of /branches/stage3.1/doc/manpage/man1/run-escript.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2945 - (show annotations)
Wed Feb 24 00:17:46 2010 UTC (8 years, 11 months ago) by jfenwick
File size: 3294 byte(s)
Bringing release stage up to trunk version 2944

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

Properties

Name Value
svn:mergeinfo /branches/lapack2681/doc/manpage/man1/escript.1:2682-2741 /branches/restext/doc/manpage/man1/escript.1:2610-2624 /trunk/doc/manpage/man1/run-escript.1:2924-2944

  ViewVC Help
Powered by ViewVC 1.1.26