spinn_front_end_common.interface package

Subpackages

Submodules

spinn_front_end_common.interface.spinnaker_main_interface module

main interface for the spinnaker tools

class spinn_front_end_common.interface.spinnaker_main_interface.SpinnakerMainInterface(config, executable_finder, graph_label=None, database_socket_addresses=None, extra_algorithm_xml_paths=None, extra_mapping_inputs=None, extra_mapping_algorithms=None, extra_pre_run_algorithms=None, extra_post_run_algorithms=None, n_chips_required=None, extra_load_algorithms=None)[source]

Bases: object

Main interface into the tools logic flow

add_application_edge(edge_to_add, partition_identifier)[source]
Parameters:
  • edge_to_add
  • partition_identifier – the partition identifier for the outgoing edge partition
Return type:

None

add_application_vertex(vertex_to_add)[source]
Parameters:vertex_to_add – the vertex to add to the graph
Return type:None
Raises:ConfigurationException when both graphs contain vertices
add_machine_edge(edge, partition_id)[source]
Parameters:
  • edge – the edge to add to the graph
  • partition_id – the partition identifier for the outgoing edge partition
Return type:

None

add_machine_vertex(vertex)[source]
Parameters:vertex – the vertex to add to the graph
Return type:None
Raises:ConfigurationException when both graphs contain vertices
application_graph
buffer_manager

The buffer manager being used for loading/extracting buffers

dsg_algorithm

The dsg algorithm used by the tools

exception_handler(exctype, value, traceback_obj)[source]
generate_file_machine()[source]
get_current_time()[source]
graph_mapper
has_ran
increment_none_labelled_edge_count()[source]

Increment the number of new edges which have not been labelled.

increment_none_labelled_vertex_count()[source]

Increment the number of new vertices which have not been labelled.

machine

The python machine object

Return type:spinn_machine.machine.Machine
machine_graph
machine_time_step
no_machine_time_steps
none_labelled_edge_count

The number of times edges have not been labelled.

none_labelled_vertex_count

The number of times vertices have not been labelled.

placements
reset()[source]

Code that puts the simulation back at time zero

routing_infos
run(run_time)[source]
Parameters:run_time – the run duration in milliseconds.
Return type:None
set_up_machine_specifics(hostname)[source]

Adds machine specifics for the different modes of execution

signal_handler(signal, frame)[source]
stop(turn_off_machine=None, clear_routing_tables=None, clear_tags=None, extract_provenance_data=True, extract_iobuf=True)[source]
Parameters:
  • turn_off_machine (bool) – decides if the machine should be powered down after running the execution. Note that this powers down all boards connected to the BMP connections given to the transceiver
  • clear_routing_tables (bool) – informs the tool chain if it should turn off the clearing of the routing tables
  • clear_tags (boolean) – informs the tool chain if it should clear the tags off the machine at stop
  • extract_provenance_data (bool) – informs the tools if it should try to extract provenance data.
  • extract_iobuf (bool) – tells the tools if it should try to extract iobuf
Return type:

None

timescale_factor
transceiver
use_virtual_board

True if this run is using a virtual machine

Module contents