flux.queue module

class flux.queue.QueueDefaults(duration: float)

Bases: object

Class representing common queue defaults.

duration

Default job duration in seconds.

Type: float

timelimit

Synonym for duration.

Type: float

duration: float

property timelimit: timelimit is a alternate field name for duration for use in flux queue list

class flux.queue.QueueInfo(name, config, resources, enabled, started, default)

Bases: object

Information for a single queue.

Attrs:: name (str): The queue name (empty string for anonymous queue) is_default (bool): True if this is the default queue enabled (bool): True if this queue is enabled started (bool): True if this queue is started resources (QueueResources): resources currently in this queue defaults (QueueDefaults): defaults that apply to this queue limits (QueueLimits): policy limits that apply to this queue

class flux.queue.QueueLimits(min: QueueResourceCounts, max: QueueResourceCounts, duration: float)

Bases: object

Class representing queue limits.

min

Configured resource minimums.

Type: QueueResourceCounts

max

Configured resource maximums. (If no maximum, individual resource count will be inf)

Type: QueueResourceCounts

duration

duration limit in seconds.

Type: float

timelimit

synonym for duration.

Type: float

duration: float

max: QueueResourceCounts

min: QueueResourceCounts

property timelimit: timelimit is a alternate field name for duration for use in flux queue list

class flux.queue.QueueList(handle, queues=None)

Bases: object

Gather information about currently configured Flux queues.

Parameters

handle (flux.Flux) -- handle to Flux
queues (list) -- Optional list of queue names to target. If None or an empty list, then information for all configured queues will be targeted.

class flux.queue.QueueResourceCounts(nnodes: float, ncores: float, ngpus: float)

Bases: object

Class containing counts of basic resources, used by QueueLimits and QueueDefaults.

nnodes

Count of nodes

Type: float

ncores

Count of cores

Type: float

ngpus

Count of gpus

Type: float

ncores: float

ngpus: float

nnodes: float

class flux.queue.QueueResources(name, resources, config)

Bases: object

Container for resources assigned to an individual queue.

Attrs:

all (flux.resource.ResourceSet): all configured resources down (flux.resource.ResourceSet): down resources up (flux.resource.ResourceSet): resources that are not down allocated (flux.resource.ResourceSet): resources allocated to

jobs

free (flux.resource.ResourceSet): resources not down or: allocated to jobs