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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>mpi4py</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th bgcolor="#70b0f0" class="navbar-select"
> Home </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="https://bitbucket.org/mpi4py/mpi4py">MPI for Python</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package mpi4py
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="mpi4py-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package mpi4py</h1><p class="nomargin-top"><span class="codelink"><a href="mpi4py-pysrc.html">source code</a></span></p>
<p>This is the <strong>MPI for Python</strong> package.</p>
<div class="rst-section" id="rst-what-is-mpi">
<h1 class="heading">What is <em>MPI</em>?</h1>
<p>The <em>Message Passing Interface</em>, is a standardized and portable
message-passing system designed to function on a wide variety of
parallel computers. The standard defines the syntax and semantics of
library routines and allows users to write portable programs in the
main scientific programming languages (Fortran, C, or C++). Since
its release, the MPI specification has become the leading standard
for message-passing libraries for parallel computers.</p>
</div>
<div class="rst-section" id="rst-what-is-mpi-for-python">
<h1 class="heading">What is <em>MPI for Python</em>?</h1>
<p><em>MPI for Python</em> provides MPI bindings for the Python programming
language, allowing any Python program to exploit multiple processors.
This package is constructed on top of the MPI-1/2 specifications and
provides an object oriented interface which closely follows MPI-2 C++
bindings.</p>
</div>
<hr />
<div class="fields"> <p><strong>Version:</strong>
3.0.3
</p>
<p><strong>Author:</strong>
Lisandro Dalcin
</p>
<p><strong>Credits:</strong>
MPI Forum, MPICH Team, Open MPI Team
</p>
</div><!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Submodules</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Submodules"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr><td class="summary">
<ul class="nomargin">
<li> <strong class="uidlink"><a href="mpi4py.MPI-module.html">mpi4py.MPI</a></strong>: <em class="summary">Message Passing Interface</em> </li>
</ul></td></tr>
</table>
<br />
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="mpi4py-module.html#get_include" class="summary-sig-name" onclick="show_private();">get_include</a>()</span><br />
Return the directory in the package that contains header files.</td>
<td align="right" valign="top">
<span class="codelink"><a href="mpi4py-pysrc.html#get_include">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="get_config"></a><span class="summary-sig-name">get_config</span>()</span><br />
Return a dictionary with information about MPI.</td>
<td align="right" valign="top">
<span class="codelink"><a href="mpi4py-pysrc.html#get_config">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="mpi4py-module.html#rc" class="summary-sig-name" onclick="show_private();">rc</a>(<span class="summary-sig-arg">**kargs</span>)</span><br />
Runtime configuration options.</td>
<td align="right" valign="top">
<span class="codelink"><a href="mpi4py-pysrc.html#rc">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="mpi4py-module.html#profile" class="summary-sig-name" onclick="show_private();">profile</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">**kargs</span>)</span><br />
Support for the MPI profiling interface.</td>
<td align="right" valign="top">
<span class="codelink"><a href="mpi4py-pysrc.html#profile">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="get_include"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_include</span>()</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="mpi4py-pysrc.html#get_include">source code</a></span>
</td>
</tr></table>
<p>Return the directory in the package that contains header files.</p>
<p>Extension modules that need to compile against mpi4py should use
this function to locate the appropriate include directory. Using
Python distutils (or perhaps NumPy distutils):</p>
<pre class="rst-literal-block">
import mpi4py
Extension('extension_name', ...
include_dirs=[..., mpi4py.get_include()])
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="rc"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">rc</span>(<span class="sig-arg">**kargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="mpi4py-pysrc.html#rc">source code</a></span>
</td>
</tr></table>
<p>Runtime configuration options.</p>
<div class="rst-section" id="rst-parameters">
<h1 class="heading">Parameters</h1>
<dl class="rst-docutils">
<dt>initialize <span class="classifier-delimiter">:</span> <span class="rst-classifier">bool</span></dt>
<dd>Automatic MPI initialization at import (default: True).</dd>
<dt>threads <span class="classifier-delimiter">:</span> <span class="rst-classifier">bool</span></dt>
<dd>Request for thread support (default: True).</dd>
<dt>thread_level <span class="classifier-delimiter">:</span> <span class="rst-classifier">{'multiple', 'serialized', 'funneled', 'single'}</span></dt>
<dd>Level of thread support to request (default: 'multiple').</dd>
<dt>finalize <span class="classifier-delimiter">:</span> <span class="rst-classifier">None or bool</span></dt>
<dd>Automatic MPI finalization at exit (default: None).</dd>
<dt>fast_reduce <span class="classifier-delimiter">:</span> <span class="rst-classifier">bool</span></dt>
<dd>Use tree-based reductions for objects (default: True).</dd>
<dt>recv_mprobe <span class="classifier-delimiter">:</span> <span class="rst-classifier">bool</span></dt>
<dd>Use matched probes to receive objects (default: True).</dd>
<dt>errors <span class="classifier-delimiter">:</span> <span class="rst-classifier">{'exception', 'default', 'fatal'}</span></dt>
<dd>Error handling policy (default: 'exception').</dd>
</dl>
</div>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="profile"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">profile</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">**kargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="mpi4py-pysrc.html#profile">source code</a></span>
</td>
</tr></table>
<p>Support for the MPI profiling interface.</p>
<div class="rst-section" id="rst-parameters">
<h1 class="heading">Parameters</h1>
<dl class="rst-docutils">
<dt>name <span class="classifier-delimiter">:</span> <span class="rst-classifier">str</span></dt>
<dd>Name of the profiler library to load.</dd>
<dt>path <span class="classifier-delimiter">:</span> <span class="rst-classifier">list of str, optional</span></dt>
<dd>Additional paths to search for the profiler.</dd>
<dt>logfile <span class="classifier-delimiter">:</span> <span class="rst-classifier">str, optional</span></dt>
<dd>Filename prefix for dumping profiler output.</dd>
</dl>
</div>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th bgcolor="#70b0f0" class="navbar-select"
> Home </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="https://bitbucket.org/mpi4py/mpi4py">MPI for Python</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|
