mpi4py
Runtime configuration options
- mpi4py.rc
This object has attributes exposing runtime configuration options that become effective at import time of the
MPI
module.
Attributes Summary
Automatic MPI initialization at import |
|
Request initialization with thread support |
|
Level of thread support to request |
|
Automatic MPI finalization at exit |
|
Use tree-based reductions for objects |
|
Use matched probes to receive objects |
|
Error handling policy |
Attributes Documentation
- mpi4py.rc.initialize
Automatic MPI initialization at import.
- Type:
bool
- Default:
True
See also
- mpi4py.rc.threads
Request initialization with thread support.
- Type:
bool
- Default:
True
See also
- mpi4py.rc.thread_level
Level of thread support to request.
- Type:
str
- Default:
"multiple"
- Choices:
"multiple"
,"serialized"
,"funneled"
,"single"
See also
- mpi4py.rc.finalize
Automatic MPI finalization at exit.
- Type:
None
orbool
- Default:
None
See also
- mpi4py.rc.fast_reduce
Use tree-based reductions for objects.
- Type:
bool
- Default:
True
See also
- mpi4py.rc.recv_mprobe
Use matched probes to receive objects.
- Type:
bool
- Default:
True
See also
- mpi4py.rc.errors
Error handling policy.
- Type:
str
- Default:
"exception"
- Choices:
"exception"
,"default"
,"fatal"
See also
Example
MPI for Python features automatic initialization and finalization of the MPI
execution environment. By using the mpi4py.rc
object, MPI initialization and
finalization can be handled programatically:
import mpi4py
mpi4py.rc.initialize = False # do not initialize MPI automatically
mpi4py.rc.finalize = False # do not finalize MPI automatically
from mpi4py import MPI # import the 'MPI' module
MPI.Init() # manual initialization of the MPI environment
... # your finest code here ...
MPI.Finalize() # manual finalization of the MPI environment
Environment variables
The following environment variables override the corresponding attributes of
the mpi4py.rc
and MPI.pickle
objects at import time of the
MPI
module.
Note
For variables of boolean type, accepted values are 0
and 1
(interpreted as False
and True
, respectively), and strings
specifying a YAML boolean value (case-insensitive).
- MPI4PY_RC_INITIALIZE
- Type:
bool
- Default:
True
Whether to automatically initialize MPI at import time of the
mpi4py.MPI
module.See also
New in version 3.1.0.
- MPI4PY_RC_FINALIZE
- Type:
None
|bool
- Default:
None
- Choices:
None
,True
,False
Whether to automatically finalize MPI at exit time of the Python process.
See also
New in version 3.1.0.
- MPI4PY_RC_THREADS
- Type:
bool
- Default:
True
Whether to initialize MPI with thread support.
See also
New in version 3.1.0.
- MPI4PY_RC_THREAD_LEVEL
- Default:
"multiple"
- Choices:
"single"
,"funneled"
,"serialized"
,"multiple"
The level of required thread support.
See also
New in version 3.1.0.
- MPI4PY_RC_FAST_REDUCE
- Type:
bool
- Default:
True
Whether to use tree-based reductions for objects.
See also
New in version 3.1.0.
- MPI4PY_RC_RECV_MPROBE
- Type:
bool
- Default:
True
Whether to use matched probes to receive objects.
See also
- MPI4PY_RC_ERRORS
- Default:
"exception"
- Choices:
"exception"
,"default"
,"fatal"
Controls default MPI error handling policy.
See also
New in version 3.1.0.
- MPI4PY_PICKLE_PROTOCOL
- Type:
int
- Default:
pickle.HIGHEST_PROTOCOL
Controls the default pickle protocol to use when communicating Python objects.
See also
PROTOCOL
attribute of theMPI.pickle
object within theMPI
module.New in version 3.1.0.
- MPI4PY_PICKLE_THRESHOLD
- Type:
int
- Default:
262144
Controls the default buffer size threshold for switching from in-band to out-of-band buffer handling when using pickle protocol version 5 or higher.
See also
Module
mpi4py.util.pkl5
.New in version 3.1.2.
Miscellaneous functions
- mpi4py.profile()
- mpi4py.get_config()
- mpi4py.get_include()