Node Resources Module

This module for detects and returns intranode resources

node_resources.get_cpu_cores(hyperthreads=False)

Returns the number of cores on the node.

If hyperthreads is true, this is the logical CPU cores; else the physical cores are returned.

Note: This returns cores available on the current node. It will not work for systems of multiple node types

Parameters:

hyperthreads (bool) –

Return type:

int

node_resources.get_sub_node_resources(launcher=None, remote_mode=False, env_resources=None)

Returns logical and physical cores and GPUs per node as a tuple

First checks for environment values, and and then for detected values. If remote_mode is True, then detection launches a job via the MPI launcher.

Any value that is already valid, is not overwritten by successive stages.

Parameters:

  • launcher (str | None) –

  • remote_mode (bool) –

  • env_resources (EnvResources | None) –

Return type:

Tuple[int, int, int]