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\-no-privatize\fR
  40 Disable the globals privatization, that is activated by default.
  41 This should only be necessary if you use dynamic libraries, but you
  42 should probably link statically instead of disabling this. Do not link
  43 statically against SimGrid, only the others.
  44 .TP
  45 \fB\-trace\fR
  46 Equivalent to \fB–cfg\fR=\fItracing\fR:\fIyes\fR \fB–cfg\fR=\fItracing/smpi\fR:\fIyes\fR, activate the trace mechanism if available.
  47 .TP
  48 \fB\-trace-ti\fR
  49 Activate time independant tracing.
  50 .TP
  51 \fB\-trace-comment\fR <comment>
  52 Put a comment on the top of the trace file.
  53 .TP
  54 \fB\-trace-comment-file\fR <file>
  55 Insert the content of the file at the head of the trace file as a comment.
  56 .TP
  57 \fB\-trace-grouped\fR
  58 Group MPI processes by location.
  59 .TP
  60 \fB\-trace-resource\fR
  61 Trace resource utilization.
  62 .TP
  63 \fB\-trace-viva\fR
  64 Generate configuration for Viva's GraphView.
  65 .TP
  66 \fB\-trace-file\fR <tracefile>
  67 Name of the tracefile
  68 .SH AUTHORS
  69 The SimGrid team (simgrid-devel@lists.gforge.inria.fr)
  70 .SH COPYRIGHT AND LICENCE
  71 Copyright (c) 2014. The SimGrid Team. All rights reserved.
  72
  73 This program is free software; you may redistribute it and/or modify it under the terms of GNU LGPL (v2.1) license.
  74 .SH SEE ALSO
  75 .B smpicc\fR(1)
  76 .B smpicxx\fR(1)
  77 .B smpiff\fR(1)
  78 .B smpif90\fR(1)