File: detail-placement-deprecated.rst

package info (click to toggle)
openmpi 5.0.7-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 202,312 kB
  • sloc: ansic: 612,441; makefile: 42,495; sh: 11,230; javascript: 9,244; f90: 7,052; java: 6,404; perl: 5,154; python: 1,856; lex: 740; fortran: 61; cpp: 20; tcl: 12
file content (155 lines) | stat: -rw-r--r-- 4,694 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
.. -*- rst -*-

   Copyright (c) 2022-2023 Nanook Consulting.  All rights reserved.
   Copyright (c) 2023 Jeffrey M. Squyres.  All rights reserved.

   $COPYRIGHT$

   Additional copyrights may follow

   $HEADER$

.. The following line is included so that Sphinx won't complain
   about this file not being directly included in some toctree

Deprecated options
==================

These deprecated options will be removed in a future release.

.. list-table::
   :header-rows: 1
   :widths: 20 20 30

   * - Deprecated Option
     - Replacement
     - Description

   * - ``--bind-to-core``
     - ``--bind-to core``
     - Bind processes to cores


   * - ``--bind-to-socket``
     - ``--bind-to package``
     - Bind processes to processor sockets

   * - ``--bycore``
     - ``--map-by core``
     - Map processes by core

   * - ``--bynode``
     - ``--map-by node``
     - Launch processes one per node, cycling by node in a round-robin
       fashion. This spreads processes evenly among nodes and assigns
       ranks in a round-robin, "by node" manner.

   * - ``--byslot``
     - ``--map-by slot``
     - Map and rank processes round-robin by slot

   * - ``--cpus-per-proc <#perproc>``
     - `--map-by <obj>:PE=<#perproc>``
     - Bind each process to the specified number of CPUs

   * - ``--cpus-per-rank <#perrank>``
     - ``--map-by <obj>:PE=<#perrank>``
     - Alias for ``--cpus-per-proc``

   * - ``--display-allocation``
     - ``--display ALLOC``
     - Display the detected resource allocation

   * - ``-display-devel-map``
     - ``--display MAP-DEVEL``
     - Display a detailed process map (mostly intended for developers)
       just before launch.

   * - ``--display-map``
     - ``--display MAP``
     - Display a table showing the mapped location of each process
       prior to launch.

   * - ``--display-topo``
     - ``--display TOPO``
     - Display the topology as part of the process map (mostly
       intended for developers) just before launch.

   * - ``--do-not-launch``
     - ``--map-by :DONOTLAUNCH``
     - Perform all necessary operations to prepare to launch the
       application, but do not actually launch it (usually used to
       test mapping patterns).

   * - ``--do-not-resolve``
     - ``--map-by :DONOTRESOLVE``
     - Do not attempt to resolve interfaces |mdash| usually used to
       determine proposed process placement/binding prior to obtaining
       an allocation.

   * - ``-N <num>``
     - ``--map-by prr:<num>:node``
     - Launch ``num`` processes per node on all allocated nodes

   * - ``--nolocal``
     - ``--map-by :NOLOCAL``
     - Do not run any copies of the launched application on the same
       node as ``prun`` is running. This option will override listing
       the ``localhost`` with ``--host`` or any other host-specifying
       mechanism.

   * - ``--nooversubscribe``
     - ``--map-by :NOOVERSUBSCRIBE``
     - Do not oversubscribe any nodes; error (without starting any
       processes) if the requested number of processes would cause
       oversubscription. This option implicitly sets "max_slots" equal
       to the "slots" value for each node. (Enabled by default).

   * - ``--npernode <#pernode>``
     - ``--map-by ppr:<#pernode>:node``
     - On each node, launch this many processes

   * - ``--npersocket <#persocket>``
     - ``--map-by ppr:<#perpackage>:package``
     - On each node, launch this many processes times the number of
       processor sockets on the node. The ``--npersocket`` option also
       turns on the ``--bind-to socket`` option. The term ``socket``
       has been globally replaced with ``package``.

   * - ``--oversubscribe``
     - ``--map-by :OVERSUBSCRIBE``
     - Nodes are allowed to be oversubscribed, even on a managed
       system, and overloading of processing elements.

   * - ``--pernode``
     - ``--map-by ppr:1:node``
     - On each node, launch one process

   * - ``--ppr``
     - `--map-by ppr:<list>``
     - Comma-separated list of number of processes on a given resource type
       [default: ``none``].

   * - ``--rankfile <FILENAME>``
     - ``--map-by rankfile:FILE=<FILENAME>``
     - Use a rankfile for mapping/ranking/binding

   * - ``--report-bindings``
     - ``--display BINDINGS``
     - Report any bindings for launched processes

   * - ``--tag-output``
     - ``--output TAG``
     - Tag all output with ``[job,rank]``

   * - ``--timestamp-output``
     - ``--output TIMESTAMP``
     - Timestamp all application process output

   * - ``--use-hwthread-cpus``
     - ``--map-by :HWTCPUS``
     - Use hardware threads as independent CPUs

   * - ``--xml``
     - ``--output XML``
     - Provide all output in XML format