spinn_front_end_common.utilities.utility_objs package¶
Submodules¶
spinn_front_end_common.utilities.utility_objs.executable_finder module¶
-
class
spinn_front_end_common.utilities.utility_objs.executable_finder.
ExecutableFinder
(binary_search_paths=None, include_common_binaries_folder=True)[source]¶ Bases:
spinn_utilities.executable_finder.ExecutableFinder
Manages a set of folders in which to search for binaries, and allows for binaries to be discovered within this path. This adds a default location to look to the base class.
Parameters: - binary_search_paths (iterable of str) – The initial set of folders to search for binaries.
- include_common_binaries_folder (bool) – If True (i.e. the default), the spinn_front_end_common.common_model_binaries folder is searched for binaries. If you are not using the common models, or the model binary names conflict with your own, this parameter can be used to avoid this issue. Note that the folder will be appended to the value of binary_search_paths, so the common binary search path will be looked in last.
spinn_front_end_common.utilities.utility_objs.executable_start_type module¶
-
class
spinn_front_end_common.utilities.utility_objs.executable_start_type.
ExecutableStartType
(value, doc='')[source]¶ Bases:
enum.Enum
supports starting of different types of executables
-
NO_APPLICATION
= 3¶
-
RUNNING
= 0¶
-
SYNC
= 1¶
-
USES_SIMULATION_INTERFACE
= (2, 'Calls simulation_run() and simulation_exit() / simulation_handle_pause_resume()')¶
-
spinn_front_end_common.utilities.utility_objs.live_packet_gather_parameters module¶
-
class
spinn_front_end_common.utilities.utility_objs.live_packet_gather_parameters.
LivePacketGatherParameters
(port, hostname, tag, board_address, strip_sdp, use_prefix, key_prefix, prefix_type, message_type, right_shift, payload_as_time_stamps, use_payload_prefix, payload_prefix, payload_right_shift, number_of_packets_sent_per_time_step, partition_id)[source]¶ Bases:
object
parameter holder for LPG’s so that they can be instantiated at a later date.
-
board_address
¶
-
hostname
¶
-
key_prefix
¶
-
message_type
¶
-
number_of_packets_sent_per_time_step
¶
-
partition_id
¶
-
payload_as_time_stamps
¶
-
payload_prefix
¶
-
payload_right_shift
¶
-
port
¶
-
prefix_type
¶
-
right_shift
¶
-
strip_sdp
¶
-
tag
¶
-
use_payload_prefix
¶
-
use_prefix
¶
-
spinn_front_end_common.utilities.utility_objs.provenance_data_item module¶
-
class
spinn_front_end_common.utilities.utility_objs.provenance_data_item.
ProvenanceDataItem
(names, value, report=False, message=None)[source]¶ Bases:
object
Container for provenance data
Parameters: - names – A list of strings representing the hierarchy of naming of this item
- value – The value of the item
- report – True if the item should be reported to the user
- message – The message to send to the end user if report is True
-
message
¶ The message to report to the end user, or None if no message
-
names
¶ The hierarchy of names of this bit of provenance data
-
report
¶ True if this provenance data entry needs reporting to the end user
-
value
¶ The value of the item
Module contents¶
-
class
spinn_front_end_common.utilities.utility_objs.
ExecutableFinder
(binary_search_paths=None, include_common_binaries_folder=True)[source]¶ Bases:
spinn_utilities.executable_finder.ExecutableFinder
Manages a set of folders in which to search for binaries, and allows for binaries to be discovered within this path. This adds a default location to look to the base class.
Parameters: - binary_search_paths (iterable of str) – The initial set of folders to search for binaries.
- include_common_binaries_folder (bool) – If True (i.e. the default), the spinn_front_end_common.common_model_binaries folder is searched for binaries. If you are not using the common models, or the model binary names conflict with your own, this parameter can be used to avoid this issue. Note that the folder will be appended to the value of binary_search_paths, so the common binary search path will be looked in last.
-
class
spinn_front_end_common.utilities.utility_objs.
ExecutableStartType
(value, doc='')[source]¶ Bases:
enum.Enum
supports starting of different types of executables
-
NO_APPLICATION
= 3¶
-
RUNNING
= 0¶
-
SYNC
= 1¶
-
USES_SIMULATION_INTERFACE
= (2, 'Calls simulation_run() and simulation_exit() / simulation_handle_pause_resume()')¶
-
-
class
spinn_front_end_common.utilities.utility_objs.
LivePacketGatherParameters
(port, hostname, tag, board_address, strip_sdp, use_prefix, key_prefix, prefix_type, message_type, right_shift, payload_as_time_stamps, use_payload_prefix, payload_prefix, payload_right_shift, number_of_packets_sent_per_time_step, partition_id)[source]¶ Bases:
object
parameter holder for LPG’s so that they can be instantiated at a later date.
-
board_address
¶
-
hostname
¶
-
key_prefix
¶
-
message_type
¶
-
number_of_packets_sent_per_time_step
¶
-
partition_id
¶
-
payload_as_time_stamps
¶
-
payload_prefix
¶
-
payload_right_shift
¶
-
port
¶
-
prefix_type
¶
-
right_shift
¶
-
strip_sdp
¶
-
tag
¶
-
use_payload_prefix
¶
-
use_prefix
¶
-
-
class
spinn_front_end_common.utilities.utility_objs.
ProvenanceDataItem
(names, value, report=False, message=None)[source]¶ Bases:
object
Container for provenance data
Parameters: - names – A list of strings representing the hierarchy of naming of this item
- value – The value of the item
- report – True if the item should be reported to the user
- message – The message to send to the end user if report is True
-
message
¶ The message to report to the end user, or None if no message
-
names
¶ The hierarchy of names of this bit of provenance data
-
report
¶ True if this provenance data entry needs reporting to the end user
-
value
¶ The value of the item