Environment Variables

The following environment variables are set for every process that is started by a call to the Dragon Client API, to Dragon Native or to Python Multiprocessing.

class LaunchParameters

Bases: object

Launch Parameters for Dragon processes.

This class contains the basic runtime parameters for Dragon infrastructure and managed processes.

The parameter names are available in the environment of every Dragon managed process with the prefix DRAGON_. E.g. DRAGON_MY_PUID for MY_PUID. Setting some of these parameters will alter runtime behaviour. E.g. setting DRAGON_DEBUG=1 in the environment before starting the runtime, will setup the runtime in debug mode and result in verbose log files.

The parameter names are available as attributes with lower cased names in Python.

The following launch parameters are defined

Parameters:

  • MODE (str) – Startup mode of the infrastructure, one of 'crayhpe-multi', 'single', 'test', defaults to 'test'.

  • INDEX (int) – Internal non-negative index of the current node, defaults to 0.

  • DEFAULT_PD (str) – Base64 encoded serialized descriptor of the default user memory pool, defaults to ‘’.

  • INF_PD (str) – Base64 encoded serialized descriptor of the default infrastructure memory pool, defaults to ‘’.

  • LOCAL_SHEP_CD (str) – Base64 encoded serialized descriptor of the channel to send to the local services on the same node, defaults to ‘’.

  • LOCAL_BE_CD (str) – Base64 encoded serialized descriptor of the channel to send to the launcher backend on the same node, defaults to ‘’.

  • GS_CD (str) – Base64 encoded serialized descriptor of the channel to send to global services, defaults to ‘’.

  • GS_RET_CD (str) – Base64 encoded serialized descriptor of the channel to receive from global services, defaults to ‘’.

  • SHEP_RET_CD (str) – Base64 encoded serialized descriptor of the channel to receive from the local services on the same node, defaults to ‘’.

  • DEFAULT_SEG_SZ (int) – Size of the default user managed memory pool in bytes, defaults to 2**32.

  • INF_SEG_SZ (int) – Size of the default infrastructure managed memory pool in bytes, defaults to 2**30.

  • MY_PUID (int) – Unique process ID (puid) given to this process by global services, defaults to 1.

  • TEST (int) – if in test mode, defaults to 0.

  • DEBUG (int) – if in debug mode, defaults to 0.

  • BE_CUID (int) – Unique channel ID (cuid) of the launcher backend on this node, defaults to 2**60.

  • INF_WAIT_MODE (str) – Default wait mode of infrastructure objects. One of 'IDLE_WAIT', 'SPIN_WAIT', or 'ADAPTIVE_WAIT'. Defaults to 'IDLE_WAIT'.

  • USER_WAIT_MODE (str) – Default wait mode of user objects. One of 'IDLE_WAIT', 'SPIN_WAIT', , or 'ADAPTIVE_WAIT'. defaults to 'ADAPTIVE_WAIT'.

  • INF_RETURN_WHEN_MODE (str) – Default return mode for infrastructure objects. One of 'WHEN_IMMEDIATE', 'WHEN_BUFFERED', 'WHEN_DEPOSITED', 'WHEN_RECEIVED', defaults to 'WHEN_BUFFERED'.

  • USER_RETURN_WHEN_MODE (str) – Default return mode for user objects. One of 'WHEN_IMMEDIATE', 'WHEN_BUFFERED', 'WHEN_DEPOSITED', 'WHEN_RECEIVED', defaults to 'WHEN_DEPOSITED'.

  • GW_CAPACITY (int) – Positive capacity of gateway channels, defaults to 2048.

  • HSTA_MAX_EJECTION_MB (int) – Size in MB of buffers used for network receive operations. This controls network ejection rate, defaults to 8.

  • HSTA_MAX_GETMSG_MB (int) – Size in MB of buffers used for local 'getmsg’ operations. This controls memory consumption rate for messages with 'GETMSG’ protocol, defaults to 8.

  • HSTA_FABRIC_BACKEND (str) – Select the fabric backend to use. Possible options are 'ofi’, 'ucx’, and 'mpi’, defaults to 'ofi’.

  • HSTA_TRANSPORT_TYPE (str) – Select if HSTA uses point-to-point operations or RDMA Get to send large messages. Possible options are 'p2p’ and 'rma’, defaults to 'p2p’.

  • PMOD_COMMUNICATION_TIMEOUT (int) – Timeout in seconds for PMOD communication with child MPI processes, defaults to 30.

  • BASEPOOL (str) – Default implementation of multiprocessing pool. One of 'NATIVE' or 'PATCHED', defaults to 'NATIVE'.

__init__(**kwargs)