iarray.get_ncores#

iarray.get_ncores(max_ncores=0)#

Get the number of logical cores in the system.

Parameters

max_ncores (int) – If > 0, the returned number is capped at this value. If == 0 (default), the actual number of logical cores in the system is returned.

Returns

The (capped) number of logical cores. In case of error, a 1 is returned and a warning is issued.

Return type

int