bout_runners.submitter.processor_split¶

Contains the processor split class.

Classes

ProcessorSplit(number_of_processors, …)

Class which sets the processor split.

class bout_runners.submitter.processor_split.ProcessorSplit(number_of_processors: int = 1, number_of_nodes: int = 1, processors_per_node: int = 1)[source]¶

Class which sets the processor split.

Examples

>>> processor_split = ProcessorSplit(number_of_processors=1,
...                                  number_of_nodes=1,
...                                  processors_per_node=1)

>>> processor_split = ProcessorSplit(number_of_processors=2,
...                                  number_of_nodes=1,
...                                  processors_per_node=1)
Traceback (most recent call last):
  File "<input>", line 1, in <module>
ValueError: number_of_nodes*processors_per_node = 1, whereas
number_of_processors = 2

Attributes

__number_of_processorsNone or int: Getter and setter variable for number_of_processors
__number_of_nodesNone or int: Getter and setter variable for number_of_nodes
__processors_per_nodeNone or int: Getter and setter variable for processors_per_node
number_of_processorsint: Set the properties of self.number_of_processors.
number_of_nodesint: Set the properties of self.number_of_nodes.
processors_per_nodeint: Set the properties of self.processors_per_node.

Set the parameters.

Parameters

number_of_processorsint: The total number of processors to use
number_of_nodesint: How many nodes to run on (only effective on clusters)
processors_per_nodeint: The number of processors to allocate per node (only effective on clusters)

Attributes

number_of_nodes: Set the properties of self.number_of_nodes.
number_of_processors: Set the properties of self.number_of_processors.
processors_per_node: Set the properties of self.processors_per_node.

property number_of_nodes¶

Set the properties of self.number_of_nodes.

Returns

int: The number of nodes

property number_of_processors¶

Set the properties of self.number_of_processors.

Returns

int: The number of processors

property processors_per_node¶

Set the properties of self.processors_per_node.

Returns

int: The number of nodes