# Diff of /trunk/doc/user/execute.tex

revision 2343 by jfenwick, Mon Mar 30 01:34:45 2009 UTC revision 2352 by jfenwick, Wed Apr 1 01:15:15 2009 UTC
# Line 44  This runs the script on $8$ nodes, with Line 44  This runs the script on $8$ nodes, with
44  \section{Options}  \section{Options}
45  The general form of the \program{escript} launcher is as follows:  The general form of the \program{escript} launcher is as follows:
46
47    %%%%
48    % If you are thinking about changing this please remember to update the man page as well
49    %%%%
50
51  \program{escript}  \program{escript}
52  \optional{\programopt{-n \var{nn}}}  \optional{\programopt{-n \var{nn}}}
53  \optional{\programopt{-p \var{np}}}  \optional{\programopt{-p \var{np}}}
# Line 70  The options are used as follows: Line 74  The options are used as follows:
74  \begin{itemize}  \begin{itemize}
75
76   \item[\programopt{-n} \var{nn}] the number of compute nodes \var{nn} to be used. The total number of process being used is   \item[\programopt{-n} \var{nn}] the number of compute nodes \var{nn} to be used. The total number of process being used is
77  $\var{nn} \cdot \var{ns}$. This option overwrites the value of the \env{ESCRIPT_NUM_NODES} environment variable. If $\var{nn}>1$ but {\it escript}  is not compiled for \MPI a warning is pronted but execution is continued with $\var{nn}=1$. The default value is 1.  $\var{nn} \cdot \var{ns}$. This option overwrites the value of the \env{ESCRIPT_NUM_NODES} environment variable. If $\var{nn}>1$ but {\it escript}  is not compiled for \MPI a warning is printed but execution is continued with $\var{nn}=1$. If \programopt{-n} is not set the
78    number of hosts in the host file is used. The default value is 1.
79
80  \item[\programopt{-p} \var{np}] the number of processor slots per node. This options specifies how many \MPI processes are used on each node. The total number of process being used is  \item[\programopt{-p} \var{np}] the number of MPI processes per node.  The total number of processes to be used is
81  $\var{nn} \cdot \var{np}$. This option overwrites the value of the \env{ESCRIPT_NUM_PROC} environment variable. If $\var{np}>1$ but {\it escript}  is not compiled for \MPI a warning is printed but execution is continued with $\var{np}=1$. The default value is 1.  $\var{nn} \cdot \var{np}$. This option overwrites the value of the \env{ESCRIPT_NUM_PROC} environment variable. If $\var{np}>1$ but {\it escript}  is not compiled for \MPI a warning is printed but execution is continued with $\var{np}=1$. The default value is 1.
82
83   \item[\programopt{-t} \var{nt}] the number of threads used per processes.   \item[\programopt{-t} \var{nt}] the number of threads used per processes.
84  The option overwrites the value of the \env{ESCRIPT_NUM_THREADS} environment variable.  The option overwrites the value of the \env{ESCRIPT_NUM_THREADS} environment variable.
85  If $\var{nt}>1$ but {\it escript} is not compiled for \OPENMP a warning is printed but execution is continued with $\var{nt}=1$. The default value is 1.  If $\var{nt}>1$ but {\it escript} is not compiled for \OPENMP a warning is printed but execution is continued with $\var{nt}=1$. The default value is 1.
86
87   \item[\programopt{-f} \var{hostfile}] 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 \var{hostfile}. In order to avoid oversubsription the number of differnt   \item[\programopt{-f} \var{hostfile}] 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 \var{hostfile}. If \programopt{-n} is set the
88  hosts defined in \var{hostfile} must be greater or equal to the number of requsted compute nodes \var{nn}. The option overwrites the value of the \env{ESCRIPT_HOSTFILE} environment variable. By default value no host file is used.  the number of different
89    hosts defined in \var{hostfile} must be equal to the number of requsted compute nodes \var{nn}. The option overwrites the value of the \env{ESCRIPT_HOSTFILE} environment variable. By default value no host file is used.
90   \item[\programopt{-c}] prints the information about the settings used to compile {\it escript} and stops execution..   \item[\programopt{-c}] prints the information about the settings used to compile {\it escript} and stops execution..
91   \item[\programopt{-V}] prints the version of {\it escript} and stops execution.   \item[\programopt{-V}] prints the version of {\it escript} and stops execution.
92   \item[\programopt{-h}] prints a help message and stops execution.   \item[\programopt{-h}] prints a help message and stops execution.
# Line 89  hosts defined in \var{hostfile} must be Line 95  hosts defined in \var{hostfile} must be
95
96   \item[\programopt{-e}] shows additional environment variables and commands used during \program{escript} execution. This option is useful if users wish to excute scripts without using the \program{escript} command.   \item[\programopt{-e}] shows additional environment variables and commands used during \program{escript} execution. This option is useful if users wish to excute scripts without using the \program{escript} command.
97
98   \item[\programopt{-o}] switches on the redirection of output of processors with \MPI rank greater than zero to the files \file{stdout_\var{r}.out} and \file{stderr_\var{r}.out} where \var{r} is the rank of the processor. The option overwrites the value of the \env{ESCRIPT_STDFILES} environment variable   \item[\programopt{-o}] switches on the redirection of output of processors with \MPI rank greater than zero to the files \file{stdout_\var{r}.out} and \file{stderr_\var{r}.out} where \var{r} is the rank of the processor. The option overwrites the value of the \env{ESCRIPT_CREATESTDFILES} environment variable
99
100  %  \item[\programopt{-x}] interpret \var{file} as an \esysxml \footnote{{\it esysxml} has not been released yet.} task.  %  \item[\programopt{-x}] interpret \var{file} as an \esysxml \footnote{{\it esysxml} has not been released yet.} task.
101  % This option is still expermental.  % This option is still expermental.
# Line 100  hosts defined in \var{hostfile} must be Line 106  hosts defined in \var{hostfile} must be
106  \section{Input and Output}  \section{Input and Output}
107  When \MPI is used on more than one process ($\var{nn} \cdot \var{np} >1$) no input from the standard input is accepted. Standard output on any process other the the master process (\var{rank}=0) will not be available.  When \MPI is used on more than one process ($\var{nn} \cdot \var{np} >1$) no input from the standard input is accepted. Standard output on any process other the the master process (\var{rank}=0) will not be available.
108  Error output from any processor will be redirected to the node where \program{escript} has been envoked.  Error output from any processor will be redirected to the node where \program{escript} has been envoked.
109  If the \programopt{-o} or \env{ESCRIPT_STDFILES} is set\footnote{That is, it has a non-empty value.}, then the standard and error output from any process other than the master process will be written to files of the names \file{stdout_\var{r}.out} and \file{stderr_\var{r}.out} (where  If the \programopt{-o} or \env{ESCRIPT_CREATESTDFILES} is set\footnote{That is, it has a non-empty value.}, then the standard and error output from any process other than the master process will be written to files of the names \file{stdout_\var{r}.out} and \file{stderr_\var{r}.out} (where
110  \var{r} is the rank of the process).  \var{r} is the rank of the process).
111
112  If files are created or read by individual \MPI processes with information local to the process (e.g in the \function{dump} function)  and more than one process is used ($\var{nn} \cdot \var{np} >1$), the \MPI process rank is appended to the file names.  If files are created or read by individual \MPI processes with information local to the process (e.g in the \function{dump} function)  and more than one process is used ($\var{nn} \cdot \var{np} >1$), the \MPI process rank is appended to the file names.

Legend:
 Removed from v.2343 changed lines Added in v.2352