mpi4py.MPI

Classes

Ancillary

Datatype	Datatype object.
Status	Status object.
Request	Request handler.
Prequest	Persistent request handler.
Grequest	Generalized request handler.
Op	Reduction operation.
Group	Group of processes.
Info	Info object.
Session	Session context.

Communication

Comm	Communication context.
Intracomm	Intracommunicator.
Topocomm	Topology intracommunicator.
Cartcomm	Cartesian topology intracommunicator.
Graphcomm	General graph topology intracommunicator.
Distgraphcomm	Distributed graph topology intracommunicator.
Intercomm	Intercommunicator.
Message	Matched message.

One-sided operations

Win	Remote memory access context.

Input/Output

File	File I/O context.

Error handling

Errhandler	Error handler.
Exception	Exception class.

Auxiliary

Pickle	Pickle/unpickle Python objects.
buffer	Buffer.

Functions

Version inquiry

Get_version()	Obtain the version number of the MPI standard.
Get_library_version()	Obtain the version string of the MPI library.

Initialization and finalization

Init()	Initialize the MPI execution environment.
Init_thread([required])	Initialize the MPI execution environment.
Finalize()	Terminate the MPI execution environment.
Is_initialized()	Indicate whether Init has been called.
Is_finalized()	Indicate whether Finalize has completed.
Query_thread()	Return the level of thread support provided by the MPI library.
Is_thread_main()	Indicate whether this thread called Init or Init_thread.

Memory allocation

Alloc_mem(size[, info])	Allocate memory for message passing and remote memory access.
Free_mem(mem)	Free memory allocated with Alloc_mem.

Address manipulation

Get_address(location)	Get the address of a location in memory.
Aint_add(base, disp)	Return the sum of base address and displacement.
Aint_diff(addr1, addr2)	Return the difference between absolute addresses.

Timer

Wtick()	Return the resolution of Wtime.
Wtime()	Return an elapsed time on the calling processor.

Error handling

Get_error_class(errorcode)	Convert an error code into an error class.
Get_error_string(errorcode)	Return the error string for a given error class or error code.
Add_error_class()	Add an error class to the known error classes.
Add_error_code(errorclass)	Add an error code to an error class.
Add_error_string(errorcode, string)	Associate an error string with an error class or error code.
Remove_error_class(errorclass)	Remove an error class from the known error classes.
Remove_error_code(errorcode)	Remove an error code from the known error codes.
Remove_error_string(errorcode)	Remove error string association from error class or error code.

Dynamic process management

Open_port([info])	Return an address used to connect group of processes.
Close_port(port_name)	Close a port.
Publish_name(service_name, port_name[, info])	Publish a service name.
Unpublish_name(service_name, port_name[, info])	Unpublish a service name.
Lookup_name(service_name[, info])	Lookup a port name given a service name.

Miscellanea

Attach_buffer(buf)	Attach a user-provided buffer for sending in buffered mode.
Detach_buffer()	Remove an existing attached buffer.
Flush_buffer()	Block until all buffered messages have been transmitted.
Iflush_buffer()	Nonblocking flush for buffered messages.
Compute_dims(nnodes, dims)	Return a balanced distribution of processes per coordinate direction.
Get_processor_name()	Obtain the name of the calling processor.
Register_datarep(datarep, read_fn, write_fn, ...)	Register user-defined data representations.
Pcontrol(level)	Control profiling.

Utilities

get_vendor()

Information about the underlying MPI implementation.

Attributes

UNDEFINED	Constant UNDEFINED of type int
ANY_SOURCE	Constant ANY_SOURCE of type int
ANY_TAG	Constant ANY_TAG of type int
PROC_NULL	Constant PROC_NULL of type int
ROOT	Constant ROOT of type int
BOTTOM	Constant BOTTOM of type BottomType
IN_PLACE	Constant IN_PLACE of type InPlaceType
BUFFER_AUTOMATIC	Constant BUFFER_AUTOMATIC of type BufferAutomaticType
KEYVAL_INVALID	Constant KEYVAL_INVALID of type int
TAG_UB	Constant TAG_UB of type int
IO	Constant IO of type int
WTIME_IS_GLOBAL	Constant WTIME_IS_GLOBAL of type int
UNIVERSE_SIZE	Constant UNIVERSE_SIZE of type int
APPNUM	Constant APPNUM of type int
LASTUSEDCODE	Constant LASTUSEDCODE of type int
WIN_BASE	Constant WIN_BASE of type int
WIN_SIZE	Constant WIN_SIZE of type int
WIN_DISP_UNIT	Constant WIN_DISP_UNIT of type int
WIN_CREATE_FLAVOR	Constant WIN_CREATE_FLAVOR of type int
WIN_FLAVOR	Constant WIN_FLAVOR of type int
WIN_MODEL	Constant WIN_MODEL of type int
SUCCESS	Constant SUCCESS of type int
ERR_LASTCODE	Constant ERR_LASTCODE of type int
ERR_COMM	Constant ERR_COMM of type int
ERR_GROUP	Constant ERR_GROUP of type int
ERR_TYPE	Constant ERR_TYPE of type int
ERR_REQUEST	Constant ERR_REQUEST of type int
ERR_OP	Constant ERR_OP of type int
ERR_ERRHANDLER	Constant ERR_ERRHANDLER of type int
ERR_BUFFER	Constant ERR_BUFFER of type int
ERR_COUNT	Constant ERR_COUNT of type int
ERR_TAG	Constant ERR_TAG of type int
ERR_RANK	Constant ERR_RANK of type int
ERR_ROOT	Constant ERR_ROOT of type int
ERR_TRUNCATE	Constant ERR_TRUNCATE of type int
ERR_IN_STATUS	Constant ERR_IN_STATUS of type int
ERR_PENDING	Constant ERR_PENDING of type int
ERR_TOPOLOGY	Constant ERR_TOPOLOGY of type int
ERR_DIMS	Constant ERR_DIMS of type int
ERR_ARG	Constant ERR_ARG of type int
ERR_OTHER	Constant ERR_OTHER of type int
ERR_UNKNOWN	Constant ERR_UNKNOWN of type int
ERR_INTERN	Constant ERR_INTERN of type int
ERR_INFO	Constant ERR_INFO of type int
ERR_FILE	Constant ERR_FILE of type int
ERR_WIN	Constant ERR_WIN of type int
ERR_KEYVAL	Constant ERR_KEYVAL of type int
ERR_INFO_KEY	Constant ERR_INFO_KEY of type int
ERR_INFO_VALUE	Constant ERR_INFO_VALUE of type int
ERR_INFO_NOKEY	Constant ERR_INFO_NOKEY of type int
ERR_ACCESS	Constant ERR_ACCESS of type int
ERR_AMODE	Constant ERR_AMODE of type int
ERR_BAD_FILE	Constant ERR_BAD_FILE of type int
ERR_FILE_EXISTS	Constant ERR_FILE_EXISTS of type int
ERR_FILE_IN_USE	Constant ERR_FILE_IN_USE of type int
ERR_NO_SPACE	Constant ERR_NO_SPACE of type int
ERR_NO_SUCH_FILE	Constant ERR_NO_SUCH_FILE of type int
ERR_IO	Constant ERR_IO of type int
ERR_READ_ONLY	Constant ERR_READ_ONLY of type int
ERR_CONVERSION	Constant ERR_CONVERSION of type int
ERR_DUP_DATAREP	Constant ERR_DUP_DATAREP of type int
ERR_UNSUPPORTED_DATAREP	Constant ERR_UNSUPPORTED_DATAREP of type int
ERR_UNSUPPORTED_OPERATION	Constant ERR_UNSUPPORTED_OPERATION of type int
ERR_NAME	Constant ERR_NAME of type int
ERR_NO_MEM	Constant ERR_NO_MEM of type int
ERR_NOT_SAME	Constant ERR_NOT_SAME of type int
ERR_PORT	Constant ERR_PORT of type int
ERR_QUOTA	Constant ERR_QUOTA of type int
ERR_SERVICE	Constant ERR_SERVICE of type int
ERR_SPAWN	Constant ERR_SPAWN of type int
ERR_BASE	Constant ERR_BASE of type int
ERR_SIZE	Constant ERR_SIZE of type int
ERR_DISP	Constant ERR_DISP of type int
ERR_ASSERT	Constant ERR_ASSERT of type int
ERR_LOCKTYPE	Constant ERR_LOCKTYPE of type int
ERR_RMA_CONFLICT	Constant ERR_RMA_CONFLICT of type int
ERR_RMA_SYNC	Constant ERR_RMA_SYNC of type int
ERR_RMA_RANGE	Constant ERR_RMA_RANGE of type int
ERR_RMA_ATTACH	Constant ERR_RMA_ATTACH of type int
ERR_RMA_SHARED	Constant ERR_RMA_SHARED of type int
ERR_RMA_FLAVOR	Constant ERR_RMA_FLAVOR of type int
ORDER_C	Constant ORDER_C of type int
ORDER_F	Constant ORDER_F of type int
ORDER_FORTRAN	Constant ORDER_FORTRAN of type int
TYPECLASS_INTEGER	Constant TYPECLASS_INTEGER of type int
TYPECLASS_REAL	Constant TYPECLASS_REAL of type int
TYPECLASS_COMPLEX	Constant TYPECLASS_COMPLEX of type int
DISTRIBUTE_NONE	Constant DISTRIBUTE_NONE of type int
DISTRIBUTE_BLOCK	Constant DISTRIBUTE_BLOCK of type int
DISTRIBUTE_CYCLIC	Constant DISTRIBUTE_CYCLIC of type int
DISTRIBUTE_DFLT_DARG	Constant DISTRIBUTE_DFLT_DARG of type int
COMBINER_NAMED	Constant COMBINER_NAMED of type int
COMBINER_DUP	Constant COMBINER_DUP of type int
COMBINER_CONTIGUOUS	Constant COMBINER_CONTIGUOUS of type int
COMBINER_VECTOR	Constant COMBINER_VECTOR of type int
COMBINER_HVECTOR	Constant COMBINER_HVECTOR of type int
COMBINER_INDEXED	Constant COMBINER_INDEXED of type int
COMBINER_HINDEXED	Constant COMBINER_HINDEXED of type int
COMBINER_INDEXED_BLOCK	Constant COMBINER_INDEXED_BLOCK of type int
COMBINER_HINDEXED_BLOCK	Constant COMBINER_HINDEXED_BLOCK of type int
COMBINER_STRUCT	Constant COMBINER_STRUCT of type int
COMBINER_SUBARRAY	Constant COMBINER_SUBARRAY of type int
COMBINER_DARRAY	Constant COMBINER_DARRAY of type int
COMBINER_RESIZED	Constant COMBINER_RESIZED of type int
COMBINER_VALUE_INDEX	Constant COMBINER_VALUE_INDEX of type int
COMBINER_F90_REAL	Constant COMBINER_F90_REAL of type int
COMBINER_F90_COMPLEX	Constant COMBINER_F90_COMPLEX of type int
COMBINER_F90_INTEGER	Constant COMBINER_F90_INTEGER of type int
IDENT	Constant IDENT of type int
CONGRUENT	Constant CONGRUENT of type int
SIMILAR	Constant SIMILAR of type int
UNEQUAL	Constant UNEQUAL of type int
CART	Constant CART of type int
GRAPH	Constant GRAPH of type int
DIST_GRAPH	Constant DIST_GRAPH of type int
UNWEIGHTED	Constant UNWEIGHTED of type int
WEIGHTS_EMPTY	Constant WEIGHTS_EMPTY of type int
COMM_TYPE_SHARED	Constant COMM_TYPE_SHARED of type int
BSEND_OVERHEAD	Constant BSEND_OVERHEAD of type int
WIN_FLAVOR_CREATE	Constant WIN_FLAVOR_CREATE of type int
WIN_FLAVOR_ALLOCATE	Constant WIN_FLAVOR_ALLOCATE of type int
WIN_FLAVOR_DYNAMIC	Constant WIN_FLAVOR_DYNAMIC of type int
WIN_FLAVOR_SHARED	Constant WIN_FLAVOR_SHARED of type int
WIN_SEPARATE	Constant WIN_SEPARATE of type int
WIN_UNIFIED	Constant WIN_UNIFIED of type int
MODE_NOCHECK	Constant MODE_NOCHECK of type int
MODE_NOSTORE	Constant MODE_NOSTORE of type int
MODE_NOPUT	Constant MODE_NOPUT of type int
MODE_NOPRECEDE	Constant MODE_NOPRECEDE of type int
MODE_NOSUCCEED	Constant MODE_NOSUCCEED of type int
LOCK_EXCLUSIVE	Constant LOCK_EXCLUSIVE of type int
LOCK_SHARED	Constant LOCK_SHARED of type int
MODE_RDONLY	Constant MODE_RDONLY of type int
MODE_WRONLY	Constant MODE_WRONLY of type int
MODE_RDWR	Constant MODE_RDWR of type int
MODE_CREATE	Constant MODE_CREATE of type int
MODE_EXCL	Constant MODE_EXCL of type int
MODE_DELETE_ON_CLOSE	Constant MODE_DELETE_ON_CLOSE of type int
MODE_UNIQUE_OPEN	Constant MODE_UNIQUE_OPEN of type int
MODE_SEQUENTIAL	Constant MODE_SEQUENTIAL of type int
MODE_APPEND	Constant MODE_APPEND of type int
SEEK_SET	Constant SEEK_SET of type int
SEEK_CUR	Constant SEEK_CUR of type int
SEEK_END	Constant SEEK_END of type int
DISPLACEMENT_CURRENT	Constant DISPLACEMENT_CURRENT of type int
DISP_CUR	Constant DISP_CUR of type int
THREAD_SINGLE	Constant THREAD_SINGLE of type int
THREAD_FUNNELED	Constant THREAD_FUNNELED of type int
THREAD_SERIALIZED	Constant THREAD_SERIALIZED of type int
THREAD_MULTIPLE	Constant THREAD_MULTIPLE of type int
VERSION	Constant VERSION of type int
SUBVERSION	Constant SUBVERSION of type int
MAX_PROCESSOR_NAME	Constant MAX_PROCESSOR_NAME of type int
MAX_ERROR_STRING	Constant MAX_ERROR_STRING of type int
MAX_PORT_NAME	Constant MAX_PORT_NAME of type int
MAX_INFO_KEY	Constant MAX_INFO_KEY of type int
MAX_INFO_VAL	Constant MAX_INFO_VAL of type int
MAX_OBJECT_NAME	Constant MAX_OBJECT_NAME of type int
MAX_DATAREP_STRING	Constant MAX_DATAREP_STRING of type int
MAX_LIBRARY_VERSION_STRING	Constant MAX_LIBRARY_VERSION_STRING of type int
DATATYPE_NULL	Object DATATYPE_NULL of type Datatype
PACKED	Object PACKED of type Datatype
BYTE	Object BYTE of type Datatype
AINT	Object AINT of type Datatype
OFFSET	Object OFFSET of type Datatype
COUNT	Object COUNT of type Datatype
CHAR	Object CHAR of type Datatype
WCHAR	Object WCHAR of type Datatype
SIGNED_CHAR	Object SIGNED_CHAR of type Datatype
SHORT	Object SHORT of type Datatype
INT	Object INT of type Datatype
LONG	Object LONG of type Datatype
LONG_LONG	Object LONG_LONG of type Datatype
UNSIGNED_CHAR	Object UNSIGNED_CHAR of type Datatype
UNSIGNED_SHORT	Object UNSIGNED_SHORT of type Datatype
UNSIGNED	Object UNSIGNED of type Datatype
UNSIGNED_LONG	Object UNSIGNED_LONG of type Datatype
UNSIGNED_LONG_LONG	Object UNSIGNED_LONG_LONG of type Datatype
FLOAT	Object FLOAT of type Datatype
DOUBLE	Object DOUBLE of type Datatype
LONG_DOUBLE	Object LONG_DOUBLE of type Datatype
C_BOOL	Object C_BOOL of type Datatype
INT8_T	Object INT8_T of type Datatype
INT16_T	Object INT16_T of type Datatype
INT32_T	Object INT32_T of type Datatype
INT64_T	Object INT64_T of type Datatype
UINT8_T	Object UINT8_T of type Datatype
UINT16_T	Object UINT16_T of type Datatype
UINT32_T	Object UINT32_T of type Datatype
UINT64_T	Object UINT64_T of type Datatype
C_COMPLEX	Object C_COMPLEX of type Datatype
C_FLOAT_COMPLEX	Object C_FLOAT_COMPLEX of type Datatype
C_DOUBLE_COMPLEX	Object C_DOUBLE_COMPLEX of type Datatype
C_LONG_DOUBLE_COMPLEX	Object C_LONG_DOUBLE_COMPLEX of type Datatype
CXX_BOOL	Object CXX_BOOL of type Datatype
CXX_FLOAT_COMPLEX	Object CXX_FLOAT_COMPLEX of type Datatype
CXX_DOUBLE_COMPLEX	Object CXX_DOUBLE_COMPLEX of type Datatype
CXX_LONG_DOUBLE_COMPLEX	Object CXX_LONG_DOUBLE_COMPLEX of type Datatype
SHORT_INT	Object SHORT_INT of type Datatype
INT_INT	Object INT_INT of type Datatype
TWOINT	Object TWOINT of type Datatype
LONG_INT	Object LONG_INT of type Datatype
FLOAT_INT	Object FLOAT_INT of type Datatype
DOUBLE_INT	Object DOUBLE_INT of type Datatype
LONG_DOUBLE_INT	Object LONG_DOUBLE_INT of type Datatype
CHARACTER	Object CHARACTER of type Datatype
LOGICAL	Object LOGICAL of type Datatype
INTEGER	Object INTEGER of type Datatype
REAL	Object REAL of type Datatype
DOUBLE_PRECISION	Object DOUBLE_PRECISION of type Datatype
COMPLEX	Object COMPLEX of type Datatype
DOUBLE_COMPLEX	Object DOUBLE_COMPLEX of type Datatype
LOGICAL1	Object LOGICAL1 of type Datatype
LOGICAL2	Object LOGICAL2 of type Datatype
LOGICAL4	Object LOGICAL4 of type Datatype
LOGICAL8	Object LOGICAL8 of type Datatype
INTEGER1	Object INTEGER1 of type Datatype
INTEGER2	Object INTEGER2 of type Datatype
INTEGER4	Object INTEGER4 of type Datatype
INTEGER8	Object INTEGER8 of type Datatype
INTEGER16	Object INTEGER16 of type Datatype
REAL2	Object REAL2 of type Datatype
REAL4	Object REAL4 of type Datatype
REAL8	Object REAL8 of type Datatype
REAL16	Object REAL16 of type Datatype
COMPLEX4	Object COMPLEX4 of type Datatype
COMPLEX8	Object COMPLEX8 of type Datatype
COMPLEX16	Object COMPLEX16 of type Datatype
COMPLEX32	Object COMPLEX32 of type Datatype
UNSIGNED_INT	Object UNSIGNED_INT of type Datatype
SIGNED_SHORT	Object SIGNED_SHORT of type Datatype
SIGNED_INT	Object SIGNED_INT of type Datatype
SIGNED_LONG	Object SIGNED_LONG of type Datatype
SIGNED_LONG_LONG	Object SIGNED_LONG_LONG of type Datatype
BOOL	Object BOOL of type Datatype
SINT8_T	Object SINT8_T of type Datatype
SINT16_T	Object SINT16_T of type Datatype
SINT32_T	Object SINT32_T of type Datatype
SINT64_T	Object SINT64_T of type Datatype
F_BOOL	Object F_BOOL of type Datatype
F_INT	Object F_INT of type Datatype
F_FLOAT	Object F_FLOAT of type Datatype
F_DOUBLE	Object F_DOUBLE of type Datatype
F_COMPLEX	Object F_COMPLEX of type Datatype
F_FLOAT_COMPLEX	Object F_FLOAT_COMPLEX of type Datatype
F_DOUBLE_COMPLEX	Object F_DOUBLE_COMPLEX of type Datatype
REQUEST_NULL	Object REQUEST_NULL of type Request
MESSAGE_NULL	Object MESSAGE_NULL of type Message
MESSAGE_NO_PROC	Object MESSAGE_NO_PROC of type Message
OP_NULL	Object OP_NULL of type Op
MAX	Object MAX of type Op
MIN	Object MIN of type Op
SUM	Object SUM of type Op
PROD	Object PROD of type Op
LAND	Object LAND of type Op
BAND	Object BAND of type Op
LOR	Object LOR of type Op
BOR	Object BOR of type Op
LXOR	Object LXOR of type Op
BXOR	Object BXOR of type Op
MAXLOC	Object MAXLOC of type Op
MINLOC	Object MINLOC of type Op
REPLACE	Object REPLACE of type Op
NO_OP	Object NO_OP of type Op
GROUP_NULL	Object GROUP_NULL of type Group
GROUP_EMPTY	Object GROUP_EMPTY of type Group
INFO_NULL	Object INFO_NULL of type Info
INFO_ENV	Object INFO_ENV of type Info
ERRHANDLER_NULL	Object ERRHANDLER_NULL of type Errhandler
ERRORS_RETURN	Object ERRORS_RETURN of type Errhandler
ERRORS_ARE_FATAL	Object ERRORS_ARE_FATAL of type Errhandler
COMM_NULL	Object COMM_NULL of type Comm
COMM_SELF	Object COMM_SELF of type Intracomm
COMM_WORLD	Object COMM_WORLD of type Intracomm
WIN_NULL	Object WIN_NULL of type Win
FILE_NULL	Object FILE_NULL of type File
pickle	Object pickle of type Pickle