.TH "makeflow_mpi_starter" 1 "" "CCTools 7.1.2 FINAL" "Cooperative Computing Tools"

.SH NAME
.LP
\fBmakeflow_mpi_starter\fP - mpi wrapper program for makeflow and workqueue

.SH SYNOPSIS
.LP
\FC\fBmakeflow_mpi_starter [options]\fP\FT

.SH DESCRIPTION
.LP

\fBmakeflow_mpi_starter\fP is an MPI wrapper program that will start Makeflow and
WorkQueue on the nodes allocated to it. It is intended as a simple, easy way for 
users to take advantage of MPI-based system while using Makeflow and WorkQueue. To
use it, the user simply needs to call it as one would a regular MPI program. For
the program to work, cctools needs to be configured with \FC--with-mpicc-path\FT.

.SH OPTIONS
.LP
When \FCmakeflow_mpi_starter\FT is ran without arguments, it will attempt to execute the
workflow specified by the \fBMakeflow\fP dagfile.

.SS Commands
.LP
.LP
.TP
\fB-m\fP, \fB-\-makeflow-arguments\fP=\fI<option>\fP
.
Options to pass to makeflow, such as dagfile, etc
.TP
\fB-p\fP, \fB-\-makeflow-port\fP=\fI<port>\fP
.
The port for Makeflow to use when communicating with workers
.TP
\fB-q\fP, \fB-\-workqueue-arguments\fP=\fI<option>\fP
.
Options to pass to work_queue_worker
.TP
\fB-c\fP, \fB-\-copy-out\fP=\fI<location>\fP
.
Where to copy out all files produced
.TP
\fB-d\fP, \fB-\-debug\fP=\fI<debugprefix>\fP
.
Base Debug file name
.TP
.B \ -h, --help
.
Print out this help


.SH EXIT STATUS
.LP
On success, returns zero.  On failure, returns non-zero.

.SH EXAMPLES
.LP

Run with debugging:
.fam C
.nf
.nh
.IP "" 8
mpirun -np $NUM_PROC makeflow_mpi_starter -m "Makeflow.mf" -d mydebug
.fi
.hy
.fam
.P

Run makeflow with custom port:
.fam C
.nf
.nh
.IP "" 8
mpirun -np $NUM_PROC makeflow_mpi_starter -m "Makeflow.mf" -d mydebug -p 9001
.fi
.hy
.fam
.P

Run makeflow with garbage collection
.fam C
.nf
.nh
.IP "" 8
mpirun -np $NUM_PROC makeflow_mpi_starter -m "-gall Makeflow.mf" -d mydebug
.fi
.hy
.fam
.P

Example SGE submission script
.fam C
.nf
.nh
.IP "" 8

#!/bin/csh

#$ -pe mpi-* 120         
#$ -q debug              
#$ -N mpi_starter_example     

module load ompi

mpirun -np $NSLOTS makeflow_mpi_starter -m "Makeflow.mf" -d mydebug
.fi
.hy
.fam
.P

.SH COPYRIGHT
.LP

The Cooperative Computing Tools are Copyright (C) 2005-2019 The University of Notre Dame.  This software is distributed under the GNU General Public License.  See the file COPYING for details.

.SH SEE ALSO
.LP


.IP \(bu 4
\fBCooperative Computing Tools Documentation\fP
.IP \(bu 4
\fBMakeflow User Manual\fP
.IP \(bu 4
\fBmakeflow(1)\fP \fBmakeflow_monitor(1)\fP \fBmakeflow_analyze(1)\fP \fBmakeflow_viz(1)\fP \fBmakeflow_graph_log(1)\fP \fBstarch(1)\fP \fBmakeflow_ec2_setup(1)\fP \fBmakeflow_ec2_cleanup(1)\fP 


SEE_ALSO_WORKQUEUE