spinn_front_end_common.interface.interface_functions package

Submodules

spinn_front_end_common.interface.interface_functions.front_end_common_application_data_loader module

class spinn_front_end_common.interface.interface_functions.front_end_common_application_data_loader.FrontEndCommonApplicationDataLoader[source]

Bases: object

spinn_front_end_common.interface.interface_functions.front_end_common_application_finisher module

class spinn_front_end_common.interface.interface_functions.front_end_common_application_finisher.FrontEndCommonApplicationFinisher[source]

Bases: object

spinn_front_end_common.interface.interface_functions.front_end_common_application_runner module

class spinn_front_end_common.interface.interface_functions.front_end_common_application_runner.FrontEndCommonApplicationRunner[source]

Bases: object

Ensures all cores are initialised correctly, ran, and completed successfully.

spinn_front_end_common.interface.interface_functions.front_end_common_buffer_extractor module

class spinn_front_end_common.interface.interface_functions.front_end_common_buffer_extractor.FrontEndCommonBufferExtractor[source]

Bases: object

Extracts data in between runs

spinn_front_end_common.interface.interface_functions.front_end_common_buffer_manager_creator module

class spinn_front_end_common.interface.interface_functions.front_end_common_buffer_manager_creator.FrontEndCommonBufferManagerCreator[source]

Bases: object

spinn_front_end_common.interface.interface_functions.front_end_common_chip_iobuf_clearer module

class spinn_front_end_common.interface.interface_functions.front_end_common_chip_iobuf_clearer.FrontEndCommonChipIOBufClearer[source]

Bases: object

Updates the runtime of an application running on a spinnaker machine

spinn_front_end_common.interface.interface_functions.front_end_common_chip_iobuf_extractor module

class spinn_front_end_common.interface.interface_functions.front_end_common_chip_iobuf_extractor.FrontEndCommonChipIOBufExtractor[source]

Bases: object

Extract iobuf buffers from the machine, and separates lines based on their prefix

spinn_front_end_common.interface.interface_functions.front_end_common_chip_provenance_updater module

class spinn_front_end_common.interface.interface_functions.front_end_common_chip_provenance_updater.FrontEndCommonChipProvenanceUpdater[source]

Bases: object

Forces all cores to generate provenance data, and then exit

spinn_front_end_common.interface.interface_functions.front_end_common_chip_runtime_updater module

class spinn_front_end_common.interface.interface_functions.front_end_common_chip_runtime_updater.FrontEndCommonChipRuntimeUpdater[source]

Bases: object

Updates the runtime of an application running on a spinnaker machine

spinn_front_end_common.interface.interface_functions.front_end_common_database_interface module

class spinn_front_end_common.interface.interface_functions.front_end_common_database_interface.FrontEndCommonDatabaseInterface[source]

Bases: object

Writes a database of the graph(s) and other information

database_file_path

spinn_front_end_common.interface.interface_functions.front_end_common_dsg_region_reloader module

class spinn_front_end_common.interface.interface_functions.front_end_common_dsg_region_reloader.FrontEndCommonDSGRegionReloader[source]

Bases: object

Regenerates Data Specifications

spinn_front_end_common.interface.interface_functions.front_end_common_edge_to_n_keys_mapper module

class spinn_front_end_common.interface.interface_functions.front_end_common_edge_to_n_keys_mapper.FrontEndCommonEdgeToNKeysMapper[source]

Bases: object

Works out the number of keys needed for each edge

spinn_front_end_common.interface.interface_functions.front_end_common_graph_binary_gatherer module

class spinn_front_end_common.interface.interface_functions.front_end_common_graph_binary_gatherer.FrontEndCommonGraphBinaryGatherer[source]

Bases: object

Extracts binaries to be executed

spinn_front_end_common.interface.interface_functions.front_end_common_graph_data_specification_writer module

class spinn_front_end_common.interface.interface_functions.front_end_common_graph_data_specification_writer.FrontEndCommonGraphDataSpecificationWriter[source]

Bases: object

Executes data specification generation

spinn_front_end_common.interface.interface_functions.front_end_common_graph_measurer module

class spinn_front_end_common.interface.interface_functions.front_end_common_graph_measurer.FrontEndCommonGraphMeasurer[source]

Bases: object

Works out how many chips a machine graph needs

spinn_front_end_common.interface.interface_functions.front_end_common_graph_provenance_gatherer module

class spinn_front_end_common.interface.interface_functions.front_end_common_graph_provenance_gatherer.FrontEndCommonGraphProvenanceGatherer[source]

Bases: object

spinn_front_end_common.interface.interface_functions.front_end_common_hbp_allocator module

class spinn_front_end_common.interface.interface_functions.front_end_common_hbp_allocator.FrontEndCommonHBPAllocator[source]

Bases: object

Request a machine from the HBP remote access server that will fit a number of chips

spinn_front_end_common.interface.interface_functions.front_end_common_hbp_max_machine_generator module

class spinn_front_end_common.interface.interface_functions.front_end_common_hbp_max_machine_generator.FrontEndCommonHBPMaxMachineGenerator[source]

Bases: object

Generates the width and height of the maximum machine a given HBP server can generate

spinn_front_end_common.interface.interface_functions.front_end_common_host_execute_data_specification module

class spinn_front_end_common.interface.interface_functions.front_end_common_host_execute_data_specification.FrontEndCommonHostExecuteDataSpecification[source]

Bases: object

Executes the host based data specification

static generate_report_writer(write_text_specs, report_default_directory, hostname, x, y, p)[source]

Generate a writer for the human readable report of the dsg

Parameters:
  • write_text_specs – True if the textual version of the specification is to be written
  • report_default_directory – Folder where reports are to be written
  • hostname – machine name
  • x – chip coord in x axis
  • y – chip coord in y axis
  • p – processor id
Returns:

writer object for the report

static get_application_data_file_path(processor_chip_x, processor_chip_y, processor_id, hostname, application_run_time_folder)[source]
Parameters:
  • processor_chip_x – chip coord in x axis
  • processor_chip_y – chip coord in y axis
  • processor_id – processor id
  • hostname – machine name
  • application_run_time_folder – folder to store application data
Returns:

name of file to store dsg data

host_based_data_specification_execution(hostname, transceiver, write_text_specs, application_data_runtime_folder, machine, report_default_directory, app_id, dsg_targets)[source]

executes the DSE

Parameters:
  • hostname – spinnaker machine name
  • report_default_directory – the location where reports are stored
  • write_text_specs – True if the textual version of the specification is to be written
  • runtime_application_data_folder – Folder where data specifications should be written to
  • machine – the python representation of the spinnaker machine
  • transceiver – the spinnman instance
  • app_id – the application ID of the simulation
  • dsg_targets – map of placement to file path
Returns:

map of placement and dsg data, and loaded data flag.

spinn_front_end_common.interface.interface_functions.front_end_common_load_executable_images module

class spinn_front_end_common.interface.interface_functions.front_end_common_load_executable_images.FrontEndCommonLoadExecutableImages[source]

Bases: object

spinn_front_end_common.interface.interface_functions.front_end_common_machine_execute_data_specification module

class spinn_front_end_common.interface.interface_functions.front_end_common_machine_execute_data_specification.FrontEndCommonMachineExecuteDataSpecification[source]

Bases: object

Executes the machine based data specification

spinnaker_based_data_specification_execution(write_memory_map_report, dsg_targets, transceiver, app_id)[source]
Parameters:
  • write_memory_map_report
  • dsg_targets
  • transceiver
  • app_id
Returns:

True

Return type:

bool

spinn_front_end_common.interface.interface_functions.front_end_common_machine_generator module

class spinn_front_end_common.interface.interface_functions.front_end_common_machine_generator.FrontEndCommonMachineGenerator[source]

Bases: object

Interface to make a transceiver and a spinn_machine object

spinn_front_end_common.interface.interface_functions.front_end_common_notification_protocol module

class spinn_front_end_common.interface.interface_functions.front_end_common_notification_protocol.FrontEndCommonNotificationProtocol[source]

Bases: object

The notification protocol for external device interaction

send_read_notification(database_directory)[source]

Send the read notifications via the notification protocol

Parameters:database_directory – the path to the database
Return type:None:
send_start_resume_notification()[source]

Send the start notifications via the notification protocol

Return type:None:
send_stop_pause_notification()[source]

Send the stop or pause notifications via the notification protocol

Return type:None:
stop()[source]

Ends the notification protocol

Return type:None:
wait_for_confirmation()[source]

Waits for devices to confirm they have read the database via the notification protocol

Return type:None:

spinn_front_end_common.interface.interface_functions.front_end_common_placements_provenance_gatherer module

class spinn_front_end_common.interface.interface_functions.front_end_common_placements_provenance_gatherer.FrontEndCommonPlacementsProvenanceGatherer[source]

Bases: object

spinn_front_end_common.interface.interface_functions.front_end_common_provenance_json_writer module

class spinn_front_end_common.interface.interface_functions.front_end_common_provenance_json_writer.FrontEndCommonProvenanceJSONWriter[source]

Bases: object

Write provenance data into JSON

VALID_CHARS = frozenset([' ', ')', '(', '-', '.', '1', '0', '3', '2', '5', '4', '7', '6', '9', '8', 'A', 'C', 'B', 'E', 'D', 'G', 'F', 'I', 'H', 'K', 'J', 'M', 'L', 'O', 'N', 'Q', 'P', 'S', 'R', 'U', 'T', 'W', 'V', 'Y', 'X', 'Z', '_', 'a', 'c', 'b', 'e', 'd', 'g', 'f', 'i', 'h', 'k', 'j', 'm', 'l', 'o', 'n', 'q', 'p', 's', 'r', 'u', 't', 'w', 'v', 'y', 'x', 'z'])

spinn_front_end_common.interface.interface_functions.front_end_common_provenance_xml_writer module

class spinn_front_end_common.interface.interface_functions.front_end_common_provenance_xml_writer.FrontEndCommonProvenanceXMLWriter[source]

Bases: object

Write provenance data into XML

VALID_CHARS = frozenset([' ', ')', '(', '-', '.', '1', '0', '3', '2', '5', '4', '7', '6', '9', '8', 'A', 'C', 'B', 'E', 'D', 'G', 'F', 'I', 'H', 'K', 'J', 'M', 'L', 'O', 'N', 'Q', 'P', 'S', 'R', 'U', 'T', 'W', 'V', 'Y', 'X', 'Z', '_', 'a', 'c', 'b', 'e', 'd', 'g', 'f', 'i', 'h', 'k', 'j', 'm', 'l', 'o', 'n', 'q', 'p', 's', 'r', 'u', 't', 'w', 'v', 'y', 'x', 'z'])

spinn_front_end_common.interface.interface_functions.front_end_common_router_provenance_gatherer module

class spinn_front_end_common.interface.interface_functions.front_end_common_router_provenance_gatherer.FrontEndCommonRouterProvenanceGatherer[source]

Bases: object

FrontEndCommonRouterProvenanceGatherer: gathers diagnostics from the routers.

spinn_front_end_common.interface.interface_functions.front_end_common_routing_setup module

class spinn_front_end_common.interface.interface_functions.front_end_common_routing_setup.FrontEndCommonRoutingSetup[source]

Bases: object

spinn_front_end_common.interface.interface_functions.front_end_common_routing_table_loader module

class spinn_front_end_common.interface.interface_functions.front_end_common_routing_table_loader.FrontEndCommonRoutingTableLoader[source]

Bases: object

spinn_front_end_common.interface.interface_functions.front_end_common_spalloc_allocator module

class spinn_front_end_common.interface.interface_functions.front_end_common_spalloc_allocator.FrontEndCommonSpallocAllocator[source]

Bases: object

Request a machine from a SPALLOC server that will fit the given number of chips

spinn_front_end_common.interface.interface_functions.front_end_common_spalloc_max_machine_generator module

class spinn_front_end_common.interface.interface_functions.front_end_common_spalloc_max_machine_generator.FrontEndCommonSpallocMaxMachineGenerator[source]

Bases: object

Generates the width and height of the maximum machine a given allocation server can generate

spinn_front_end_common.interface.interface_functions.front_end_common_tags_loader module

class spinn_front_end_common.interface.interface_functions.front_end_common_tags_loader.FrontEndCommonTagsLoader[source]

Bases: object

Loads tags onto the machine

static load_iptags(iptags, transceiver, progress_bar)[source]

Loads all the iptags individually.

Parameters:
  • iptags – the iptags to be loaded.
  • transceiver – the transceiver object
Return type:

None

static load_reverse_iptags(reverse_ip_tags, transceiver, progress_bar)[source]

Loads all the reverse iptags individually.

Parameters:
  • reverse_ip_tags – the reverse iptags to be loaded
  • transceiver – the transceiver object
Return type:

None

spinn_front_end_common.interface.interface_functions.front_end_common_virtual_machine_generator module

class spinn_front_end_common.interface.interface_functions.front_end_common_virtual_machine_generator.FrontEndCommonVirtualMachineGenerator[source]

Bases: object

Module contents