=head1 NAME

B<wwmpirun>

=head1 DESCRIPTION

B<wwmpirun> Is a wrapper for the systems mpirun command. It first
locates the number of idle CPU's requested and then wraps the mpirun
command so that the user doesn't have to locate free nodes to run jobs
by hand.

=head1 OPTIONS

=over 4

=item B<--np>

Define the number of processes that you wish to launch. This is a
required option.

=item B<-m --master>

How many (if any) jobs do you wish to launch on the master. This is
assumed to be none unless you are running a lam enviornment which
requires the current node to be included (usually the master).

=item B<-l --lam>

Use the LAM-MPI runtime enviornment (eg. lamboot/lamhalt).

=item B<-h --help>

Show the help screen.

=back

=head1 ENVIORNMENT

=over 4

=item B<MPIRUN>

The actual mpirun command that is intended to be wrapped. If undefined,
this will default to 'mpirun' and will use the first one in the default
path.

=item B<NODES>

The NODES enviornment variable will limit which nodes are displayed. It can be 
used either as a list of nodes, seperated by commas, or pointed to a file 
which contains a list of node names. You can set it with the following syntax:

for bash:

=over 8

export NODES=node0000,node0001,node0010,node0011

=back

for (t)csh:

=over 8

setenv NODES /path/to/node/list/file

=back

=head1 AUTHOR

B<Warewulf> is written and maintained by Greg M. Kurtzer <gmk@lbl.gov>, and
hosted by Lawrence Berkeley National Labratory (http://www.lbl.gov).

http://warewulf-cluster.org/
