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

Annotation of /trunk/doc/manpage/man1/run-escript.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3892 - (hide annotations)
Tue Apr 10 08:57:23 2012 UTC (7 years, 7 months ago) by jfenwick
File size: 3171 byte(s)
Merged changes across from the attempt2 branch.
This version builds and passes python2 tests.
It also passes most python3 tests.



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

Properties

Name Value
svn:mergeinfo /branches/lapack2681/doc/manpage/man1/escript.1:2682-2741 /branches/pasowrap/doc/manpage/man1/run-escript.1:3661-3674 /branches/py3_attempt2/doc/manpage/man1/run-escript.1:3871-3891 /branches/restext/doc/manpage/man1/escript.1:2610-2624 /branches/ripleygmg_from_3668/doc/manpage/man1/run-escript.1:3669-3791

  ViewVC Help
Powered by ViewVC 1.1.26