Simulator clean

gfe_examples/Conways/partitioned_example_a_no_vis_no_buffer/conways_basic_cell.py

@@ -29,7 +29,7 @@
 from spinn_front_end_common.abstract_models.impl import (
     MachineDataSpecableVertex)
 from spinnaker_graph_front_end.utilities import SimulatorVertex
-from spinnaker_graph_front_end.utilities.data_utils import (
+from spinn_front_end_common.utilities.data_utils import (
     generate_system_data_region)
 
 

gfe_examples/Conways/partitioned_example_b_no_vis_buffer/conways_basic_cell.py

@@ -33,7 +33,7 @@
     import (
         get_recording_data_constant_size, get_recording_header_size)
 from spinnaker_graph_front_end.utilities import SimulatorVertex
-from spinnaker_graph_front_end.utilities.data_utils import (
+from spinn_front_end_common.utilities.data_utils import (
     generate_system_data_region)
 
 

gfe_examples/hello_world_untimed/hello_world_vertex.py

@@ -33,7 +33,7 @@
     recording_utilities)
 from spinn_front_end_common.interface.ds import DataSpecificationGenerator
 from spinnaker_graph_front_end.utilities import SimulatorVertex
-from spinnaker_graph_front_end.utilities.data_utils import (
+from spinn_front_end_common.utilities.data_utils import (
     generate_steps_system_data_region)
 import numpy
 

gfe_examples/sync_test/sync_test.py

@@ -20,7 +20,7 @@
 
 front_end.setup(
     n_boards_required=3, model_binary_folder=os.path.dirname(__file__),
-    machine_time_step=500000, time_scale_factor=1)
+    timestep=500, time_scale_factor=1)
 
 machine = front_end.machine()
 boot_chip = machine.boot_chip

gfe_examples/sync_test/sync_test_vertex.py

@@ -32,7 +32,7 @@
 from spinn_front_end_common.abstract_models import (
     AbstractGeneratesDataSpecification, AbstractHasAssociatedBinary)
 
-from spinnaker_graph_front_end.utilities.data_utils import (
+from spinn_front_end_common.utilities.data_utils import (
     generate_system_data_region)
 from pacman.model.graphs.application.abstract import (
     AbstractOneAppOneMachineVertex)

spinnaker_graph_front_end/__init__.py

@@ -62,8 +62,6 @@
 
 from pacman.model.graphs.application import (
     ApplicationEdge, ApplicationVertex)
-from pacman.model.graphs.application.abstract import (
-    AbstractOneAppOneMachineVertex)
 from pacman.model.graphs.machine import MachineEdge, MachineVertex
 from pacman.model.routing_info import RoutingInfo
 from pacman.model.tags import Tags
@@ -96,7 +94,7 @@ def setup(model_binary_module: Optional[ModuleType] = None,
           n_chips_required: Optional[int] = None,
           n_boards_required: Optional[int] = None,
           time_scale_factor: Optional[int] = None,
-          machine_time_step: Optional[int] = None) -> None:
+          *, timestep: Optional[int] = None) -> None:
     """
     Set up a graph, ready to have vertices and edges added to it, and the
     simulator engine that will execute the graph.
@@ -124,6 +122,11 @@ def setup(model_binary_module: Optional[ModuleType] = None,
         your graph, then fill this in with a general idea of the number of
         boards you need so that the spalloc system can allocate you a machine
         big enough for your needs.
+    :param time_scale_factor: multiplicative factor to the machine time step
+        (does not affect the models accuracy)
+    :param timestep:
+        the time step of the simulations in microseconds;
+        if `None`, the configuration value is used
     :raise ~spinn_front_end_common.utilities.exceptions.ConfigurationException:
         if mutually exclusive options are given.
     """
@@ -155,7 +158,7 @@ def setup(model_binary_module: Optional[ModuleType] = None,
     __simulator = SpiNNaker(
         n_chips_required=n_chips_required,
         n_boards_required=n_boards_required,
-        machine_time_step=machine_time_step,
+        timestep=timestep,
         time_scale_factor=time_scale_factor)
     FecDataView.add_database_socket_addresses(database_socket_addresses)
 
@@ -236,11 +239,7 @@ def add_machine_vertex_instance(machine_vertex: MachineVertex) -> None:
     :param machine_vertex:
         The vertex to add
     """
-    app_vertex = AbstractOneAppOneMachineVertex(
-        machine_vertex, machine_vertex.label)
-    FecDataView.add_vertex(app_vertex)
-    # pylint: disable=protected-access
-    machine_vertex._app_vertex = app_vertex
+    FecDataView.add_machine_vertex(machine_vertex)
 
 
 def add_machine_edge_instance(edge: MachineEdge, partition_id: str) -> None:
@@ -252,11 +251,7 @@ def add_machine_edge_instance(edge: MachineEdge, partition_id: str) -> None:
     :param partition_id:
         The ID of the partition that the edge belongs to.
     """
-    pre_app = edge.pre_vertex.app_vertex
-    assert pre_app is not None
-    post_app = edge.post_vertex.app_vertex
-    assert post_app is not None
-    FecDataView.add_edge(ApplicationEdge(pre_app, post_app), partition_id)
+    FecDataView.add_machine_edge(edge, partition_id)
 
 
 def add_socket_address(database_ack_port_num: Optional[int],
@@ -272,32 +267,28 @@ def add_socket_address(database_ack_port_num: Optional[int],
     :param database_notify_port_num:
         port that the external device will be notified on.
     """
-    database_socket = SocketAddress(
-        listen_port=database_ack_port_num,
-        notify_host_name=database_notify_host,
-        notify_port_no=database_notify_port_num)
-
-    FecDataView.add_database_socket_address(database_socket)
+    FecDataView.add_database_socket_port(
+        database_ack_port_num, database_notify_host, database_notify_port_num)
 
 
 def get_number_of_available_cores_on_machine() -> int:
     """
-    Get the number of cores on this machine that are available to the
+    :returns: The number of cores on this machine that are available to the
     simulation.
     """
     return __get_simulator().get_number_of_available_cores_on_machine
 
 
 def has_ran() -> bool:
     """
-    Get whether the simulation has already run.
+    :returns: True if and only if the simulation has already run.
     """
     return FecDataView.is_ran_ever()
 
 
 def routing_infos() -> RoutingInfo:
     """
-    Get information about how messages are routed on the machine.
+    :returns: The information about how messages are routed on the machine.
     """
     return FecDataView.get_routing_infos()
 
@@ -328,21 +319,21 @@ def placements() -> Never:
 
 def tags() -> Tags:
     """
-    Get the IPTAGs allocated on the machine.
+    :returns: The IPTAGs allocated on the machine.
     """
     return FecDataView.get_tags()
 
 
 def buffer_manager() -> BufferManager:
     """
-    Get the buffer manager being used for loading/extracting buffers.
+    :returns: The buffer manager being used for loading/extracting buffers.
     """
     return FecDataView.get_buffer_manager()
 
 
 def machine() -> Machine:
     """
-    Get the model of the attached/allocated machine.
+    :returns: The model of the attached/allocated machine.
     """
     logger.warning(
         "If you are getting the machine object to locate how many cores you "
@@ -355,7 +346,7 @@ def machine() -> Machine:
 
 def is_allocated_machine() -> bool:
     """
-    Get whether a machine is allocated.
+    :return: True if and only if a machine is allocated.
     """
     return FecDataView.has_machine()
 

spinnaker_graph_front_end/config_setup.py

@@ -18,29 +18,20 @@
 
 import os
 from spinn_utilities.config_holder import (
-    clear_cfg_files, set_cfg_files)
-from spinn_front_end_common.interface.config_setup import (
-    add_default_cfg, add_spinnaker_cfg)
+    add_default_cfg, clear_cfg_files)
+from spinn_front_end_common.interface.config_setup import add_spinnaker_cfg
 from spinn_front_end_common.data.fec_data_writer import FecDataWriter
 
 #: The name of the configuration file
-CONFIG_FILE_NAME = "spiNNakerGraphFrontEnd.cfg"
+GFE_CFG = "spiNNakerGraphFrontEnd.cfg"
 
 
-def setup_configs() -> None:
+def add_gfe_cfg() -> None:
     """
-    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
-    :py:func:`~spinnaker_graph_front_end.setup` is called.
+    Adds the Graph Front end cfg default file and all previous ones
     """
-    clear_cfg_files(False)
     add_spinnaker_cfg()  # This add its dependencies too
-    set_cfg_files(
-        config_file=CONFIG_FILE_NAME,
-        default=os.path.join(os.path.dirname(__file__), CONFIG_FILE_NAME))
-    FecDataWriter.mock()
+    add_default_cfg(os.path.join(os.path.dirname(__file__), GFE_CFG))
 
 
 def unittest_setup() -> None:
@@ -51,12 +42,13 @@ def unittest_setup() -> None:
     included.
     The user configuration is *not* included!
 
-    Unsets any previous simulators and temporary directories.
+    Actual loading of the cfg file is done by config_holder
+    if and only if config values are needed.
 
     .. note::
-         This file should only be called from spinnaker_graph_front_end tests
+         This method should only be called from spinnaker_graph_front_end tests
          that do not call :py:func:`~spinnaker_graph_front_end.setup`.
     """
     clear_cfg_files(True)
-    add_spinnaker_cfg()  # This add its dependencies too
-    add_default_cfg(os.path.join(os.path.dirname(__file__), CONFIG_FILE_NAME))
+    add_gfe_cfg()
+    FecDataWriter.mock()

spinnaker_graph_front_end/spinnaker.py

@@ -13,17 +13,21 @@
 # limitations under the License.
 
 import logging
-from typing import Optional
+from typing import Optional, Type
 
 from spinn_utilities.config_holder import is_config_none
 from spinn_utilities.log import FormatAdapter
+from spinn_utilities.overrides import overrides
 
 from spinn_front_end_common.data import FecDataView
+from spinn_front_end_common.data.fec_data_writer import FecDataWriter
 from spinn_front_end_common.interface.abstract_spinnaker_base import (
     AbstractSpinnakerBase)
+from spinn_front_end_common.interface.config_setup import (
+    add_spinnaker_template)
 from spinn_front_end_common.interface.provenance import GlobalProvenance
 
-from spinnaker_graph_front_end.config_setup import setup_configs
+from spinnaker_graph_front_end.config_setup import add_gfe_cfg, GFE_CFG
 from ._version import __version__ as version
 
 logger = FormatAdapter(logging.getLogger(__name__))
@@ -49,7 +53,7 @@ def __init__(
             self, n_chips_required: Optional[int] = None,
             n_boards_required: Optional[int] = None,
             time_scale_factor: Optional[int] = None,
-            machine_time_step: Optional[int] = None):
+            timestep: Optional[int] = None):
         """
         :param n_chips_required:
             How many chips are required.
@@ -58,23 +62,34 @@ def __init__(
             How many boards are required. Unnecessary with a local board.
         :param time_scale_factor:
             The time slow-down factor
-        :param machine_time_step:
+        :param timestep:
             The size of the machine time step, in microseconds
         """
         # DSG algorithm store for user defined algorithms
 
         # At import time change the default FailedState
-        setup_configs()
-
-        super().__init__()
+        super().__init__(n_boards_required=n_boards_required,
+                         n_chips_required=n_chips_required,
+                         timestep=timestep,
+                         time_scale_factor=time_scale_factor)
 
         with GlobalProvenance() as db:
             db.insert_version("SpiNNakerGraphFrontEnd", version)
 
-        self._data_writer.set_n_required(n_boards_required, n_chips_required)
+    @overrides(AbstractSpinnakerBase._add_cfg_defaults_and_template)
+    def _add_cfg_defaults_and_template(self) -> None:
+        add_gfe_cfg()
+        add_spinnaker_template()
+
+    @property
+    @overrides(AbstractSpinnakerBase._user_cfg_file)
+    def _user_cfg_file(self) -> str:
+        return GFE_CFG
 
-        self._data_writer.set_up_timings(
-            machine_time_step, time_scale_factor, 1)
+    @property
+    @overrides(AbstractSpinnakerBase._data_writer_cls)
+    def _data_writer_cls(self) -> Type[FecDataWriter]:
+        return FecDataWriter
 
     def __repr__(self) -> str:
         if FecDataView.has_ipaddress():

spinnaker_graph_front_end/utilities/data_utils.py

@@ -15,10 +15,7 @@
 from typing import TYPE_CHECKING
 from spinn_front_end_common.abstract_models import (
     AbstractHasAssociatedBinary)
-from spinn_front_end_common.utilities.constants import SIMULATION_N_BYTES
 from spinn_front_end_common.interface.ds import DataSpecificationGenerator
-from spinn_front_end_common.interface.simulation.simulation_utilities import (
-    get_simulation_header_array, get_simulation_header_array_no_timestep)
 if TYPE_CHECKING:
     from .simulator_vertex import SimulatorVertex
 
@@ -33,14 +30,9 @@ def generate_system_data_region(
     :param region_id: The region to write to
     :param machine_vertex: The machine vertex to write for
     """
-    # reserve memory regions
-    spec.reserve_memory_region(
-        region=region_id, size=SIMULATION_N_BYTES, label='systemInfo')
-
-    # simulation .c requirements
-    spec.switch_write_focus(region_id)
-    spec.write_array(get_simulation_header_array(
-        machine_vertex.get_binary_file_name()))
+    _ = (spec, region_id, machine_vertex)
+    raise NotImplementedError(
+        "Moved to spinn_front_end_common.utilities.data_utils")
 
 
 def generate_steps_system_data_region(
@@ -53,11 +45,6 @@ def generate_steps_system_data_region(
     :param region_id: The region to write to
     :param machine_vertex: The machine vertex to write for
     """
-    # reserve memory regions
-    spec.reserve_memory_region(
-        region=region_id, size=SIMULATION_N_BYTES, label='systemInfo')
-
-    # simulation .c requirements
-    spec.switch_write_focus(region_id)
-    spec.write_array(get_simulation_header_array_no_timestep(
-        machine_vertex.get_binary_file_name()))
+    _ = (spec, region_id, machine_vertex)
+    raise NotImplementedError(
+        "Moved to spinn_front_end_common.utilities.data_utils")

spinnaker_graph_front_end/utilities/simulator_vertex.py

@@ -33,7 +33,7 @@
     recording_utilities)
 from spinn_front_end_common.interface.ds import DataSpecificationGenerator
 
-from spinnaker_graph_front_end.utilities.data_utils import (
+from spinn_front_end_common.utilities.data_utils import (
     generate_system_data_region)
 log = FormatAdapter(logging.getLogger(__file__))
 
@@ -135,6 +135,8 @@ def generate_recording_region(
         :param spec: The data specification being built
         :param region_id:
             Which region is the recording region.
+        :param channel_sizes: List of int being the number of regions
+            and then for each region its size then two zeros
         """
         spec.reserve_memory_region(
             region=region_id,