Parallel computing module

Functions for parallel computing

nest.lib.hl_api_parallel_computing.GetLocalVPs()

Return iterable representing the VPs local to the MPI rank.

nest.lib.hl_api_parallel_computing.NumProcesses()

Return the overall number of MPI processes.

Returns:

Number of overall MPI processes

Return type:

int

nest.lib.hl_api_parallel_computing.Rank()

Return the MPI rank of the local process.

Returns:

MPI rank of the local process

Return type:

int

Note

DO NOT USE Rank() TO EXECUTE ANY FUNCTION IMPORTED FROM THE nest MODULE ON A SUBSET OF RANKS IN AN MPI-PARALLEL SIMULATION.

This will lead to unpredictable behavior. Symptoms may be an error message about non-synchronous global random number generators or deadlocks during simulation. In the worst case, the simulation may complete but generate nonsensical results.

nest.lib.hl_api_parallel_computing.SetAcceptableLatency(port_name, latency)

Set the acceptable latency (in ms) for a MUSIC port.

Parameters:

• port_name (str) – MUSIC port to set latency for

• latency (float) – Latency in ms

nest.lib.hl_api_parallel_computing.SetMaxBuffered(port_name, size)

Set the maximum buffer size for a MUSIC port.

Parameters:

• port_name (str) – MUSIC port to set buffer size for

• size (int) – Buffer size

nest.lib.hl_api_parallel_computing.SyncProcesses()

Synchronize all MPI processes.