File: deprecated.html

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 (283 lines) | stat: -rw-r--r-- 18,628 bytes parent folder | download
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>8.9. Deprecated options &mdash; PMIx Reference Run Time Environment 3.0.8 documentation</title>
      <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />

  
  <!--[if lt IE 9]>
    <script src="../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
        <script src="../_static/jquery.js"></script>
        <script src="../_static/underscore.js"></script>
        <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
        <script src="../_static/doctools.js"></script>
        <script src="../_static/sphinx_highlight.js"></script>
    <script src="../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="9. Notifications" href="../notifications.html" />
    <link rel="prev" title="8.8. Rankfiles" href="rankfiles.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="../index.html" class="icon icon-home">
            PMIx Reference Run Time Environment
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../quickstart.html">1. Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release-notes.html">2. Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-help.html">3. Getting help</a></li>
<li class="toctree-l1"><a class="reference internal" href="../install.html">4. Installing PRRTE</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration.html">5. PRRTE DVM Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../how-things-work/index.html">6. How Things Work</a></li>
<li class="toctree-l1"><a class="reference internal" href="../hosts/index.html">7. Host specification</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">8. Process placement</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="overview.html">8.1. Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#definition-of-slot">8.2. Definition of ‘slot’</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#definition-of-processor-element">8.3. Definition of “processor element”</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html">8.4. Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="fundamentals.html">8.5. Fundamentals</a></li>
<li class="toctree-l2"><a class="reference internal" href="limits.html">8.6. Overloading and Oversubscribing</a></li>
<li class="toctree-l2"><a class="reference internal" href="diagnostics.html">8.7. Diagnostics</a></li>
<li class="toctree-l2"><a class="reference internal" href="rankfiles.html">8.8. Rankfiles</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">8.9. Deprecated options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../notifications.html">9. Notifications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../session-directory.html">10. Session directory</a></li>
<li class="toctree-l1"><a class="reference internal" href="../developers/index.html">11. Developer’s guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">12. Contributing to PRRTE</a></li>
<li class="toctree-l1"><a class="reference internal" href="../license.html">13. License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../man/index.html">14. PRRTE manual pages</a></li>
<li class="toctree-l1"><a class="reference internal" href="../versions.html">15. Software Version Numbers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../news/index.html">16. News</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">PMIx Reference Run Time Environment</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="index.html"><span class="section-number">8. </span>Process placement</a></li>
      <li class="breadcrumb-item active"><span class="section-number">8.9. </span>Deprecated options</li>
      <li class="wy-breadcrumbs-aside">
            <a href="../_sources/placement/deprecated.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <style>
.wy-table-responsive table td,.wy-table-responsive table th{white-space:normal}
</style><div class="section" id="deprecated-options">
<h1><span class="section-number">8.9. </span>Deprecated options<a class="headerlink" href="#deprecated-options" title="Permalink to this heading"></a></h1>
<p>These deprecated options will be removed in a future release.</p>
<table class="colwidths-given docutils align-default">
<colgroup>
<col style="width: 29%" />
<col style="width: 29%" />
<col style="width: 43%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Deprecated Option</p></th>
<th class="head"><p>Replacement</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--bind-to-core</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--bind-to</span> <span class="pre">core</span></code></p></td>
<td><p>Bind processes to cores</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--bind-to-socket</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--bind-to</span> <span class="pre">package</span></code></p></td>
<td><p>Bind processes to processor sockets</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--bycore</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--map-by</span> <span class="pre">core</span></code></p></td>
<td><p>Map processes by core</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--bynode</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--map-by</span> <span class="pre">node</span></code></p></td>
<td><p>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.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--byslot</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--map-by</span> <span class="pre">slot</span></code></p></td>
<td><p>Map and rank processes round-robin by slot</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--cpus-per-proc</span> <span class="pre">&lt;#perproc&gt;</span></code></p></td>
<td><p><cite>–map-by &lt;obj&gt;:PE=&lt;#perproc&gt;`</cite></p></td>
<td><p>Bind each process to the specified number of CPUs</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--cpus-per-rank</span> <span class="pre">&lt;#perrank&gt;</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--map-by</span> <span class="pre">&lt;obj&gt;:PE=&lt;#perrank&gt;</span></code></p></td>
<td><p>Alias for <code class="docutils literal notranslate"><span class="pre">--cpus-per-proc</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--display-allocation</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--display</span> <span class="pre">ALLOC</span></code></p></td>
<td><p>Display the detected resource allocation</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">-display-devel-map</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--display</span> <span class="pre">MAP-DEVEL</span></code></p></td>
<td><p>Display a detailed process map (mostly intended for developers)
just before launch.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--display-map</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--display</span> <span class="pre">MAP</span></code></p></td>
<td><p>Display a table showing the mapped location of each process
prior to launch.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--display-topo</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--display</span> <span class="pre">TOPO</span></code></p></td>
<td><p>Display the topology as part of the process map (mostly
intended for developers) just before launch.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--do-not-launch</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--map-by</span> <span class="pre">:DONOTLAUNCH</span></code></p></td>
<td><p>Perform all necessary operations to prepare to launch the
application, but do not actually launch it (usually used to
test mapping patterns).</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--do-not-resolve</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--map-by</span> <span class="pre">:DONOTRESOLVE</span></code></p></td>
<td><p>Do not attempt to resolve interfaces — usually used to
determine proposed process placement/binding prior to obtaining
an allocation.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">-N</span> <span class="pre">&lt;num&gt;</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--map-by</span> <span class="pre">prr:&lt;num&gt;:node</span></code></p></td>
<td><p>Launch <code class="docutils literal notranslate"><span class="pre">num</span></code> processes per node on all allocated nodes</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--nolocal</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--map-by</span> <span class="pre">:NOLOCAL</span></code></p></td>
<td><p>Do not run any copies of the launched application on the same
node as <code class="docutils literal notranslate"><span class="pre">prun</span></code> is running. This option will override listing
the <code class="docutils literal notranslate"><span class="pre">localhost</span></code> with <code class="docutils literal notranslate"><span class="pre">--host</span></code> or any other host-specifying
mechanism.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--nooversubscribe</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--map-by</span> <span class="pre">:NOOVERSUBSCRIBE</span></code></p></td>
<td><p>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).</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--npernode</span> <span class="pre">&lt;#pernode&gt;</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--map-by</span> <span class="pre">ppr:&lt;#pernode&gt;:node</span></code></p></td>
<td><p>On each node, launch this many processes</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--npersocket</span> <span class="pre">&lt;#persocket&gt;</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--map-by</span> <span class="pre">ppr:&lt;#perpackage&gt;:package</span></code></p></td>
<td><p>On each node, launch this many processes times the number of
processor sockets on the node. The <code class="docutils literal notranslate"><span class="pre">--npersocket</span></code> option also
turns on the <code class="docutils literal notranslate"><span class="pre">--bind-to</span> <span class="pre">socket</span></code> option. The term <code class="docutils literal notranslate"><span class="pre">socket</span></code>
has been globally replaced with <code class="docutils literal notranslate"><span class="pre">package</span></code>.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--oversubscribe</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--map-by</span> <span class="pre">:OVERSUBSCRIBE</span></code></p></td>
<td><p>Nodes are allowed to be oversubscribed, even on a managed
system, and overloading of processing elements.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--pernode</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--map-by</span> <span class="pre">ppr:1:node</span></code></p></td>
<td><p>On each node, launch one process</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--ppr</span></code></p></td>
<td><p><cite>–map-by ppr:&lt;list&gt;`</cite></p></td>
<td><p>Comma-separated list of number of processes on a given resource type
[default: <code class="docutils literal notranslate"><span class="pre">none</span></code>].</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--rankfile</span> <span class="pre">&lt;FILENAME&gt;</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--map-by</span> <span class="pre">rankfile:FILE=&lt;FILENAME&gt;</span></code></p></td>
<td><p>Use a rankfile for mapping/ranking/binding</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--report-bindings</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--display</span> <span class="pre">BINDINGS</span></code></p></td>
<td><p>Report any bindings for launched processes</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--tag-output</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--output</span> <span class="pre">TAG</span></code></p></td>
<td><p>Tag all output with <code class="docutils literal notranslate"><span class="pre">[job,rank]</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--timestamp-output</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--output</span> <span class="pre">TIMESTAMP</span></code></p></td>
<td><p>Timestamp all application process output</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--use-hwthread-cpus</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--map-by</span> <span class="pre">:HWTCPUS</span></code></p></td>
<td><p>Use hardware threads as independent CPUs</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--xml</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--output</span> <span class="pre">XML</span></code></p></td>
<td><p>Provide all output in XML format</p></td>
</tr>
</tbody>
</table>
</div>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="rankfiles.html" class="btn btn-neutral float-left" title="8.8. Rankfiles" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="../notifications.html" class="btn btn-neutral float-right" title="9. Notifications" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2003-2025, The PRRTE Community.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>