Simple usage of a set of MPI engines#

This example assumes you’ve started a cluster of N engines (4 in this example) as part of an MPI world.

Our documentation describes how to create an MPI profile and explains basic MPI usage of the IPython cluster.

For the simplest possible way to start 4 engines that belong to the same MPI world, you can run this in a terminal:

ipcluster start --engines=MPI -n 4

or start an MPI cluster from the cluster tab if you have one configured.

Once the cluster is running, we can connect to it and open a view into it:

import ipyparallel as ipp
rc = ipp.Client()
view = rc[:]

Let’s define a simple function that gets the MPI rank from each engine.

def mpi_rank():
    from mpi4py import MPI
    comm = MPI.COMM_WORLD
    return comm.Get_rank()
[0, 1, 3, 2]

To get a mapping of IPython IDs and MPI rank (these do not always match), you can use the get_dict method on AsyncResults.

mpi_rank.block = False
ar = mpi_rank()
{0: 0, 1: 1, 2: 3, 3: 2}

With %%px cell magic, the next cell will actually execute entirely on each engine:

from mpi4py import MPI

size = comm.Get_size()
rank = comm.Get_rank()

if rank == 0:
   data = [(i+1)**2 for i in range(size)]
   data = None
data = comm.scatter(data, root=0)

assert data == (rank+1)**2, 'data=%s, rank=%s' % (data, rank)
    'data': data,
    'rank': rank,
Out[0:8]: {'data': 1, 'rank': 0}
Out[1:8]: {'data': 4, 'rank': 1}
Out[2:8]: {'data': 16, 'rank': 3}
Out[3:8]: {'data': 9, 'rank': 2}