Changeset 100 for trunk/oarutils

Timestamp:

Nov 13, 2013, 4:52:25 PM (10 years ago)

Author:

g7moreau

Message:

• Better doc

File:

• trunk/oarutils/oar-profile.sh (modified) (1 diff)

trunk/oarutils/oar-profile.sh

@@ -168 +168 @@
 =head1 NAME
 
-oar_mpirun oar_envmpirun - OAR wrapper to launch mpi
+oar-profile.sh - OAR bash profile to source
 
 =head1 SYNOPSIS
 
- oar_mpirun command
- oar_envmpirun command
+ source oar-profile.sh
+
+ oar_mpirun [mpi_run option] command
+ oar_envmpirun [mpi_run option] command
 
 
 =head1 DESCRIPTION
 
-When you need to do MPI over a cluster,
-you need to fix your environnement used by your code on every node.
-
-
+The use of MPI over a cluster need some parameters.
+When you use a batch scheduler like OAR,
+the most important option like C<-np> and C<-machinefile> could be defined by default for most case.
+
+This bash sript define two function C<oar_mpirun> and C<oar_envmpirun>.
+These are just wrapper and for most of the case,
+defined C<-np> and C<-machinefile> for you.
+With on of these wrapper, it is possible possible to use C<mpi_run>
+without any option...
+
+Because C<mpi_run> need to launch a command on a remote node on a cluster,
+theses wrappers are actually only validate for B<OpenMPI>
+which use C<ssh> by default as its transport from one node to another.
+
+=head1 COMMAND
+
+=over 12
+
+=item B<oar_mpirun> [mpi_run option] F<program>
+
+Wrapper to C<mpirun>, use C<oarsh> as remote shell,
+set environment variable on the remote side by using option C<-x> of C<mpirun>.
+If no option C<-np> or C<-machinefile> are defined,
+set them by default from OAR environment variable C<OAR_NODE_FILE>.
+Option C<-v> (or C<--verbose>) make an echo of the real C<mpirun> command on F<stdout>.
+
+=item B<oar_envmpirun> [mpi_run option] F<program>
+
+Wrapper to C<mpirun>, use C<oar-envsh> as remote shell which transmit environment variable
+(use the variable C<OMPI_MCA_plm_rsh_agent> for that).
+If no option C<-np> or C<-machinefile> are defined,
+set them by default from OAR environment variable C<OAR_NODE_FILE>.
+Option C<-v> (or C<--verbose>) make an echo of the real C<mpirun> command on F<stdout>.
+
+=back
+
+You can use C<--machinefile>, C<-hostfile>, C<--hostfile> as alias for C<-machinefile>.
+If C<--host> C<-host> or C<-H> are defined, no option C<-machinefile> is set.
+
+At the end of the C<mpirun> option, you can use C<-->.
+Wrapper will then stop to analyse the command line.
+It could be important to use that if your F<program> has the same names for command line option...
 
 =head1 SEE ALSO
 
-oarsub
+mpirun, oarsh, oar-envsh
 
 =head1 AUTHORS