spinn_front_end_common.interface package¶
Subpackages¶
- spinn_front_end_common.interface.buffer_management package
- spinn_front_end_common.interface.ds package
- Module contents
DataRowWriter
DsSqlliteDatabase
DsSqlliteDatabase.app_items()
DsSqlliteDatabase.clear_write_info()
DsSqlliteDatabase.create_data_spec()
DsSqlliteDatabase.default_database_file()
DsSqlliteDatabase.ds_n_app_cores()
DsSqlliteDatabase.ds_n_cores()
DsSqlliteDatabase.ds_n_system_cores()
DsSqlliteDatabase.get_app_id()
DsSqlliteDatabase.get_ds()
DsSqlliteDatabase.get_write_info()
DsSqlliteDatabase.info_iteritems()
DsSqlliteDatabase.info_n_cores()
DsSqlliteDatabase.items()
DsSqlliteDatabase.keys()
DsSqlliteDatabase.mark_system_cores()
DsSqlliteDatabase.set_app_id()
DsSqlliteDatabase.set_size_info()
DsSqlliteDatabase.set_write_info()
DsSqlliteDatabase.system_items()
DsSqlliteDatabase.write_data_spec()
DsSqlliteDatabase.write_session_credentials_to_db()
- Module contents
- spinn_front_end_common.interface.interface_functions package
- Submodules
- spinn_front_end_common.interface.interface_functions.host_no_bitfield_router_compression module
- spinn_front_end_common.interface.interface_functions.machine_bit_field_router_compressor module
- Module contents
FindApplicationChipsUsed
add_command_senders()
application_finisher()
application_runner()
chip_io_buf_clearer()
chip_io_buf_extractor()
chip_provenance_updater()
chip_runtime_updater()
compute_energy_used()
create_notification_protocol()
database_interface()
energy_provenance_reporter()
execute_application_data_specs()
execute_system_data_specs()
graph_binary_gatherer()
graph_data_specification_writer()
graph_provenance_gatherer()
hbp_allocator()
host_based_bit_field_router_compressor()
insert_chip_power_monitors_to_graphs()
insert_extra_monitor_vertices_to_graphs()
load_app_images()
load_fixed_routes()
load_sys_images()
local_tdma_builder()
locate_executable_start_type()
machine_generator()
placements_provenance_gatherer()
profile_data_gatherer()
read_routing_tables_from_machine()
reload_dsg_regions()
router_provenance_gatherer()
routing_setup()
routing_table_loader()
sdram_outgoing_partition_allocator()
spalloc_allocator()
split_lpg_vertices()
system_multicast_routing_generator()
tags_loader()
virtual_machine_generator()
- spinn_front_end_common.interface.profiling package
- spinn_front_end_common.interface.provenance package
- Submodules
- spinn_front_end_common.interface.provenance.router_prov_mapper module
- Module contents
AbstractProvidesLocalProvenanceData
AbstractProvidesProvenanceDataFromMachine
FecTimer
FecTimer.APPLICATION_RUNNER
FecTimer.end_category()
FecTimer.error()
FecTimer.setup()
FecTimer.skip()
FecTimer.skip_if_cfg_false()
FecTimer.skip_if_cfgs_false()
FecTimer.skip_if_empty()
FecTimer.skip_if_has_not_run()
FecTimer.skip_if_virtual_board()
FecTimer.start_category()
FecTimer.stop_category_timing()
GlobalProvenance
GlobalProvenance.get_category_timer_sum()
GlobalProvenance.get_category_timer_sums()
GlobalProvenance.get_global_provenace_path()
GlobalProvenance.get_run_time_of_BufferExtractor()
GlobalProvenance.get_run_times()
GlobalProvenance.get_timer_provenance()
GlobalProvenance.get_timer_sum_by_algorithm()
GlobalProvenance.get_timer_sum_by_category()
GlobalProvenance.get_timer_sum_by_work()
GlobalProvenance.insert_category()
GlobalProvenance.insert_category_timing()
GlobalProvenance.insert_timing()
GlobalProvenance.insert_version()
GlobalProvenance.retreive_log_messages()
GlobalProvenance.run_query()
GlobalProvenance.store_log()
LogStoreDB
ProvenanceReader
ProvenanceReader.cores_with_late_spikes()
ProvenanceReader.demo()
ProvenanceReader.get_cores_with_provenace()
ProvenanceReader.get_last_run_database_path()
ProvenanceReader.get_monitor_by_chip()
ProvenanceReader.get_provenance_for_router()
ProvenanceReader.get_router_by_chip()
ProvenanceReader.messages()
ProvenanceReader.run_query()
ProvenanceWriter
ProvidesProvenanceDataFromMachineImpl
ProvidesProvenanceDataFromMachineImpl.N_SYSTEM_PROVENANCE_WORDS
ProvidesProvenanceDataFromMachineImpl.PROVENANCE_DATA_ENTRIES
ProvidesProvenanceDataFromMachineImpl.get_provenance_data_from_machine()
ProvidesProvenanceDataFromMachineImpl.get_provenance_data_size()
ProvidesProvenanceDataFromMachineImpl.parse_extra_provenance_items()
ProvidesProvenanceDataFromMachineImpl.parse_system_provenance_items()
ProvidesProvenanceDataFromMachineImpl.reserve_provenance_data_region()
TimerCategory
TimerWork
- spinn_front_end_common.interface.simulation package
- spinn_front_end_common.interface.splitter_selectors 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(data_writer_cls=None)[source]¶
Bases:
ConfigHandler
Main interface into the tools logic flow.
- Parameters:
n_chips_required (int) – Overrides the number of chips to allocate from spalloc_client
n_boards_required (int) – Overrides the number of boards to allocate from spalloc_client
data_writer_cls (FecDataWriter) – The Global data writer class
- property get_number_of_available_cores_on_machine¶
The number of available cores on the machine after taking into account preallocated resources.
- Returns:
number of available cores
- Return type:
- run_until_complete(n_steps=None)[source]¶
Run a simulation until it completes.
- Parameters:
n_steps (int) – If not None, this specifies that the simulation should be requested to run for the given number of steps. The host will still wait until the simulation itself says it has completed
- stop_run()[source]¶
Request that the current infinite run stop.
Note
This will need to be called from another thread as the infinite run call is blocking.
- Raises:
SpiNNUtilsException – If the stop_run was not expected in the current state.
spinn_front_end_common.interface.config_handler module¶
- class spinn_front_end_common.interface.config_handler.ConfigHandler(data_writer_cls=None)[source]¶
Bases:
object
Superclass of AbstractSpinnakerBase that handles function only dependent of the configuration and the order its methods are called.
- Parameters:
data_writer (FecDataWriter) – The Global data writer object
spinn_front_end_common.interface.config_setup module¶
- spinn_front_end_common.interface.config_setup.add_spinnaker_cfg()[source]¶
Add the local configuration and all dependent configuration files.
- spinn_front_end_common.interface.config_setup.unittest_setup()[source]¶
Does all the steps that may be required before a unit test.
Resets the configurations so only the local default configurations are included.
Unsets any previous simulators and temporary directories.
Note
This file should only be called from spinn_front_end_common/tests
spinn_front_end_common.interface.java_caller module¶
- class spinn_front_end_common.interface.java_caller.JavaCaller[source]¶
Bases:
object
Support class that holds all the stuff for running stuff in Java. This includes the work of preparing data for transmitting to Java and back.
This separates the choices of how to call the Java batch vs streaming, jar locations, parameters, etc. from the rest of the Python code.
Creates a Java caller and checks the user/configuration parameters.
- Raises:
ConfigurationException – if simple parameter checking fails.
- execute_app_data_specification(use_monitors)[source]¶
Writes all the data specifications for application cores, uploading the result to the machine.
Note
May assume that system cores are already loaded and running if use_monitors is set to True.
- Parameters:
use_monitors (bool) –
- Raises:
PacmanExternalAlgorithmFailedToCompleteException – On failure of the Java code.
- execute_data_specification()[source]¶
Writes all the data specifications, uploading the result to the machine.
- Raises:
PacmanExternalAlgorithmFailedToCompleteException – On failure of the Java code.
- execute_system_data_specification()[source]¶
Writes all the data specifications for system cores, uploading the result to the machine.
- Raises:
PacmanExternalAlgorithmFailedToCompleteException – On failure of the Java code.
- get_all_data()[source]¶
Gets all the data from the previously set placements and put these in the previously set database.
- Raises:
PacmanExternalAlgorithmFailedToCompleteException – On failure of the Java code.
- set_advanced_monitors()[source]¶
Create information describing what’s going on with the monitor cores.
- set_placements(used_placements)[source]¶
Passes in the placements leaving this class to decide pass it to Java.
Currently the extra information extracted is recording region base address but this could change if recording region saved in the database.
Currently this method uses JSON but that may well change to using the database.
- Parameters:
used_placements (Placements) – Placements that are recording. May not be all placements