doc/manpage/smpirun.1

   1 .TH smpirun 1
   2 .SH NAME
   3 smpirun \- Allow the configuration and the execution of MPI programs with simgrid and SMPI
   4 .SH SYNOPSIS
   5 smpirun [\fIOPTIONS\fR]… \fB\-platform\fR <platform.xml> \fB\-hostfile\fR <hostfile> program [\fIPROGRAM-OPTIONS\fR]…
   6 .SH DESCRIPTION
   7 smpirun provides an easy way to run programs linked to simgrid and using SMPI. It sets some default values, and generate a deployment file using the mandatory arguments \fB-platform\fR and \fB-hostfile\fR.
   8 .TP
   9 \fB\-platform\fR <platform.xml>
  10 XML file describing the platform on which we want to deploy the program
  11 .TP
  12 \fB\-hostfile\fR, \fB\-machinefile\fR <hostfile>
  13 Hostfile listing all the machines in use
  14 .SH OPTIONS
  15 .SS Configuration options
  16 The configuration of the simulation can be tweaked using \fB--cfg\fR=\fIparameter\fR:\fIvalue\fR. Refer to http://simgrid.gforge.inria.fr/simgrid/latest/doc/options.html to know what are the different possibilities.
  17 .SS Other options
  18 .TP
  19 \fB\-help\fR
  20 Print the usage and a résumé of the available options
  21 .TP
  22 \fB\-keep-temps\fR
  23 Do not remove the generated files after execution.
  24 .TP
  25 \fB\-wrapper\fR <command>
  26 Use command to run the program (e.g. "valgrind", "gdb --args", "rr record").
  27 You usually want to use the "-foreground" option as well in order to have a TTY.
  28 .TP
  29 \fB\-foreground\fR
  30 Run the child process in the foreground.
  31 This gives the child process access to the TTY.
  32 .TP
  33 \fB\-map\fR
  34 Display the machine on which each process rank is mapped.
  35 .TP
  36 \fB\-np\fR <numprocs>
  37 Use that amount of processes. By default, there is the same number of processes as there are of hosts in the hostfile.
  38 .TP
  39 \fB\-trace\fR
  40 Equivalent to \fB–cfg\fR=\fItracing\fR:\fIyes\fR \fB–cfg\fR=\fItracing/smpi\fR:\fIyes\fR, activate the trace mechanism if available.
  41 .TP
  42 \fB\-trace-ti\fR
  43 Activate time independant tracing.
  44 .TP
  45 \fB\-trace-comment\fR <comment>
  46 Put a comment on the top of the trace file.
  47 .TP
  48 \fB\-trace-comment-file\fR <file>
  49 Insert the content of the file at the head of the trace file as a comment.
  50 .TP
  51 \fB\-trace-grouped\fR
  52 Group MPI processes by location.
  53 .TP
  54 \fB\-trace-resource\fR
  55 Trace resource utilization.
  56 .TP
  57 \fB\-trace-viva\fR
  58 Generate configuration for Viva's GraphView.
  59 .TP
  60 \fB\-trace-file\fR <tracefile>
  61 Name of the tracefile
  62 .SH AUTHORS
  63 The SimGrid team (simgrid-devel@lists.gforge.inria.fr)
  64 .SH COPYRIGHT AND LICENCE
  65 Copyright (c) 2014. The SimGrid Team. All rights reserved.
  66
  67 This program is free software; you may redistribute it and/or modify it under the terms of GNU LGPL (v2.1) license.
  68 .SH SEE ALSO
  69 .B smpicc\fR(1)
  70 .B smpicxx\fR(1)
  71 .B smpiff\fR(1)
  72 .B smpif90\fR(1)