spinn_front_end_common.interface package¶
Subpackages¶
- spinn_front_end_common.interface.buffer_management package
- Subpackages
- spinn_front_end_common.interface.buffer_management.buffer_models package
- Submodules
- spinn_front_end_common.interface.buffer_management.buffer_models.abstract_receive_buffers_to_host module
- spinn_front_end_common.interface.buffer_management.buffer_models.abstract_sends_buffers_from_host module
- spinn_front_end_common.interface.buffer_management.buffer_models.sends_buffers_from_host_pre_buffered_impl module
- Module contents
- spinn_front_end_common.interface.buffer_management.storage_objects package
- Submodules
- spinn_front_end_common.interface.buffer_management.storage_objects.buffered_receiving_data module
- spinn_front_end_common.interface.buffer_management.storage_objects.buffered_sending_region module
- spinn_front_end_common.interface.buffer_management.storage_objects.buffers_sent_deque module
- spinn_front_end_common.interface.buffer_management.storage_objects.channel_buffer_state module
- spinn_front_end_common.interface.buffer_management.storage_objects.end_buffering_state module
- Module contents
- spinn_front_end_common.interface.buffer_management.buffer_models package
- Submodules
- spinn_front_end_common.interface.buffer_management.buffer_manager module
- spinn_front_end_common.interface.buffer_management.recording_utilities module
- Module contents
- Subpackages
- spinn_front_end_common.interface.interface_functions package
- Submodules
- spinn_front_end_common.interface.interface_functions.application_finisher module
- spinn_front_end_common.interface.interface_functions.application_runner module
- spinn_front_end_common.interface.interface_functions.buffer_extractor module
- spinn_front_end_common.interface.interface_functions.buffer_manager_creator module
- spinn_front_end_common.interface.interface_functions.chip_iobuf_clearer module
- spinn_front_end_common.interface.interface_functions.chip_iobuf_extractor module
- spinn_front_end_common.interface.interface_functions.chip_provenance_updater module
- spinn_front_end_common.interface.interface_functions.chip_runtime_updater module
- spinn_front_end_common.interface.interface_functions.database_interface module
- spinn_front_end_common.interface.interface_functions.dsg_region_reloader module
- spinn_front_end_common.interface.interface_functions.edge_to_n_keys_mapper module
- spinn_front_end_common.interface.interface_functions.graph_binary_gatherer module
- spinn_front_end_common.interface.interface_functions.graph_data_specification_writer module
- spinn_front_end_common.interface.interface_functions.graph_measurer module
- spinn_front_end_common.interface.interface_functions.graph_provenance_gatherer module
- spinn_front_end_common.interface.interface_functions.hbp_allocator module
- spinn_front_end_common.interface.interface_functions.hbp_max_machine_generator module
- spinn_front_end_common.interface.interface_functions.host_execute_data_specification module
- spinn_front_end_common.interface.interface_functions.insert_chip_power_monitors_to_graphs module
- spinn_front_end_common.interface.interface_functions.insert_edges_to_live_packet_gatherers module
- spinn_front_end_common.interface.interface_functions.insert_live_packet_gatherers_to_graphs module
- spinn_front_end_common.interface.interface_functions.load_executable_images module
- spinn_front_end_common.interface.interface_functions.locate_executable_start_type module
- spinn_front_end_common.interface.interface_functions.machine_execute_data_specification module
- spinn_front_end_common.interface.interface_functions.machine_generator module
- spinn_front_end_common.interface.interface_functions.notification_protocol module
- spinn_front_end_common.interface.interface_functions.placements_provenance_gatherer module
- spinn_front_end_common.interface.interface_functions.pre_allocate_resources_for_chip_power_monitor module
- spinn_front_end_common.interface.interface_functions.pre_allocate_resources_for_live_packet_gatherers module
- spinn_front_end_common.interface.interface_functions.profile_data_gatherer module
- spinn_front_end_common.interface.interface_functions.provenance_json_writer module
- spinn_front_end_common.interface.interface_functions.provenance_xml_writer module
- spinn_front_end_common.interface.interface_functions.router_provenance_gatherer module
- spinn_front_end_common.interface.interface_functions.routing_setup module
- spinn_front_end_common.interface.interface_functions.routing_table_loader module
- spinn_front_end_common.interface.interface_functions.spalloc_allocator module
- spinn_front_end_common.interface.interface_functions.spalloc_max_machine_generator module
- spinn_front_end_common.interface.interface_functions.tags_loader module
- spinn_front_end_common.interface.interface_functions.tdma_agenda_builder module
- spinn_front_end_common.interface.interface_functions.virtual_machine_generator module
- Module contents
- spinn_front_end_common.interface.profiling package
- spinn_front_end_common.interface.provenance package
- Submodules
- spinn_front_end_common.interface.provenance.abstract_provides_local_provenance_data module
- spinn_front_end_common.interface.provenance.abstract_provides_provenance_data_from_machine module
- spinn_front_end_common.interface.provenance.pacman_provenance_extractor module
- spinn_front_end_common.interface.provenance.provides_provenance_data_from_machine_impl module
- Module contents
- spinn_front_end_common.interface.simulation package
Submodules¶
spinn_front_end_common.interface.abstract_spinnaker_base module¶
main interface for the spinnaker tools
-
class
spinn_front_end_common.interface.abstract_spinnaker_base.
AbstractSpinnakerBase
(configfile, executable_finder, graph_label=None, database_socket_addresses=None, extra_algorithm_xml_paths=None, n_chips_required=None, default_config_paths=None, validation_cfg=None, front_end_versions=None)[source]¶ Bases:
spinn_front_end_common.utilities.simulator_interface.SimulatorInterface
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_live_packet_gatherer_parameters
(live_packet_gatherer_params, vertex_to_record_from)[source]¶ adds params for a new LPG if needed, or adds to the tracker for same params.
Parameters: - live_packet_gatherer_params – params to look for a LPG
- vertex_to_record_from – the vertex that needs to send to a given LPG
Return type: None
-
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
-
config
¶ helper method for the front end implementations until we remove config
-
dsg_algorithm
¶ The dsg algorithm used by the tools
-
exception_handler
(exctype, value, traceback_obj)[source]¶ handler of exceptions
Parameters: - exctype – the type of execution received
- value – the value of the exception
- traceback_obj – the trace back stuff
-
get_number_of_available_cores_on_machine
¶ returns the number of available cores on the machine after taking into account pre allocated resources
Returns: number of available cores Return type: int
-
graph_mapper
¶
-
has_ran
¶
-
has_reset_last
¶
-
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_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
¶
-
routing_infos
¶
-
run
(run_time)[source]¶ Run a simulation for a fixed amount of time
Parameters: run_time – the run duration in milliseconds.
-
set_up_machine_specifics
(hostname)[source]¶ Adds machine specifics for the different modes of execution
Parameters: hostname – machine name Return type: None
-
set_up_timings
(machine_time_step=None, time_scale_factor=None)[source]¶ Set up timings of the machine
Parameters: - machine_time_step – An explicitly specified time step for the machine. If None, the value is read from the config
- time_scale_factor – An explicitly specified time scale factor for the simulation. If None, the value is read from the config
-
signal_handler
(signal, frame)[source]¶ handles closing down of script via keyboard interrupt
Parameters: - signal – the signal received
- frame – frame executed in
Returns: None
-
stop
(turn_off_machine=None, clear_routing_tables=None, clear_tags=None)[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
Return type: None
-
timescale_factor
¶
-
transceiver
¶
-
use_virtual_board
¶ True if this run is using a virtual machine
-