mpi4py

Package mpi4py |
[hide private]
[frames] | no frames]

# Package mpi4py

source code

This is the MPI for Python package.

# What is MPI?

The Message Passing Interface, 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.

# What is MPI for Python?

MPI for Python 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.

Version: 3.0.3

Author: Lisandro Dalcin

Credits: MPI Forum, MPICH Team, Open MPI Team

Submodules | [hide private]
mpi4py.MPI: Message Passing Interface

Functions | [hide private]
get_include() Return the directory in the package that contains header files. | source code
get_config() Return a dictionary with information about MPI. | source code
rc(**kargs) Runtime configuration options. | source code
profile(name, **kargs) Support for the MPI profiling interface. | source code

Function Details | [hide private]

### get_include() | source code
Return the directory in the package that contains header files. 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):
    import mpi4py
    Extension('extension_name', ...
              include_dirs=[..., mpi4py.get_include()])

### rc(**kargs) | source code
Runtime configuration options. # Parameters initialize : bool Automatic MPI initialization at import (default: True). threads : bool Request for thread support (default: True). thread_level : {'multiple', 'serialized', 'funneled', 'single'} Level of thread support to request (default: 'multiple'). finalize : None or bool Automatic MPI finalization at exit (default: None). fast_reduce : bool Use tree-based reductions for objects (default: True). recv_mprobe : bool Use matched probes to receive objects (default: True). errors : {'exception', 'default', 'fatal'} Error handling policy (default: 'exception').

### profile(name, **kargs) | source code
Support for the MPI profiling interface. # Parameters name : str Name of the profiler library to load. path : list of str, optional Additional paths to search for the profiler. logfile : str, optional Filename prefix for dumping profiler output.