spinnaker_graph_front_end package¶
Subpackages¶
Submodules¶
spinnaker_graph_front_end.config_setup module¶
Utilities for setting up the global configuration.
- spinnaker_graph_front_end.config_setup.CONFIG_FILE_NAME = 'spiNNakerGraphFrontEnd.cfg'¶
The name of the configuration file
- spinnaker_graph_front_end.config_setup.setup_configs() None[source]¶
Sets up the configurations including the user’s configuration file.
Clears out any previous read configurations but does not load the new configurations so a warning is generated if a configuration is used before
setup()is called.
- spinnaker_graph_front_end.config_setup.unittest_setup() None[source]¶
Does all the steps that may be required before a unit test.
Resets the configurations so only the local default configurations are included. The user configuration is not included!
Unsets any previous simulators and temporary directories.
Note
This file should only be called from spinnaker_graph_front_end tests that do not call
setup().
spinnaker_graph_front_end.spinnaker module¶
- class spinnaker_graph_front_end.spinnaker.SpiNNaker(n_chips_required: int | None = None, n_boards_required: int | None = None, time_scale_factor: int | None = None, machine_time_step: int | None = None)[source]¶
Bases:
AbstractSpinnakerBaseThe implementation of the SpiNNaker simulation interface.
Note
You should not normally instantiate this directly from user code. Call
setup()instead.- Parameters:
n_chips_required – How many chips are required. Prefer n_boards_required if possible.
n_boards_required – How many boards are required. Unnecessary with a local board.
time_scale_factor – The time slow-down factor
machine_time_step – The size of the machine time step, in microseconds