File: manual.html

package info (click to toggle)
mpi4py 3.0.3-8
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 12,428 kB
  • sloc: python: 18,672; javascript: 9,118; ansic: 7,092; makefile: 567; sh: 183; f90: 158; cpp: 103
file content (160 lines) | stat: -rw-r--r-- 9,067 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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>MPI for Python &#8212; MPI for Python 3.0.3 documentation</title>
    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="_static/language_data.js"></script>
    
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" /> 
  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">MPI for Python 3.0.3 documentation</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="mpi-for-python">
<h1>MPI for Python<a class="headerlink" href="#mpi-for-python" title="Permalink to this headline">ΒΆ</a></h1>
<div class="topic">
<p class="topic-title first">Abstract</p>
<p>This document describes the <em>MPI for Python</em> package.  <em>MPI for
Python</em> provides bindings of the <em>Message Passing Interface</em> (MPI)
standard for the Python programming language, allowing any Python
program to exploit multiple processors.</p>
<p>This package is constructed on top of the MPI-1/2/3 specifications
and provides an object oriented interface which resembles the
MPI-2 C++ bindings. It supports point-to-point (sends, receives)
and collective (broadcasts, scatters, gathers) communications of
any <em>picklable</em> Python object, as well as optimized communications
of Python object exposing the single-segment buffer interface
(NumPy arrays, builtin bytes/string/array objects)</p>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="intro.html#what-is-mpi">What is MPI?</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#what-is-python">What is Python?</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#related-projects">Related Projects</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview.html#communicating-python-objects-and-array-data">Communicating Python Objects and Array Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#communicators">Communicators</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#point-to-point-communications">Point-to-Point Communications</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#collective-communications">Collective Communications</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dynamic-process-management">Dynamic Process Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#one-sided-communications">One-Sided Communications</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#parallel-input-output">Parallel Input/Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#environmental-management">Environmental Management</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#running-python-scripts-with-mpi">Running Python scripts with MPI</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#point-to-point-communication">Point-to-Point Communication</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#collective-communication">Collective Communication</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#mpi-io">MPI-IO</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#dynamic-process-management">Dynamic Process Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#wrapping-with-swig">Wrapping with SWIG</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#wrapping-with-f2py">Wrapping with F2Py</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mpi4py.futures.html">mpi4py.futures</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mpi4py.futures.html#concurrent-futures">concurrent.futures</a></li>
<li class="toctree-l2"><a class="reference internal" href="mpi4py.futures.html#mpipoolexecutor">MPIPoolExecutor</a></li>
<li class="toctree-l2"><a class="reference internal" href="mpi4py.futures.html#mpicommexecutor">MPICommExecutor</a></li>
<li class="toctree-l2"><a class="reference internal" href="mpi4py.futures.html#command-line">Command line</a></li>
<li class="toctree-l2"><a class="reference internal" href="mpi4py.futures.html#examples">Examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mpi4py.run.html">mpi4py.run</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mpi4py.run.html#interface-options">Interface options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="citing.html">Citation</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#using-pip-or-easy-install">Using <strong>pip</strong> or <strong>easy_install</strong></a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#using-distutils">Using <strong>distutils</strong></a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#testing">Testing</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="appendix.html">Appendix</a><ul>
<li class="toctree-l2"><a class="reference internal" href="appendix.html#mpi-enabled-python-interpreter">MPI-enabled Python interpreter</a></li>
<li class="toctree-l2"><a class="reference internal" href="appendix.html#building-mpi-from-sources">Building MPI from sources</a></li>
</ul>
</li>
</ul>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/manual.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    </div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">MPI for Python 3.0.3 documentation</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2019, Lisandro Dalcin.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
    </div>
  </body>
</html>