Source code for spinnaker_graph_front_end.spinnaker

# Copyright (c) 2016 The University of Manchester
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import logging
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 add_gfe_cfg, GFE_CFG
from ._version import __version__ as version

logger = FormatAdapter(logging.getLogger(__name__))


def _is_allocated_machine() -> bool:
    if is_config_none("Machine", "spalloc_server"):
        return not is_config_none("Machine", "remote_spinnaker_url")
    else:
        return True




class SpiNNaker(AbstractSpinnakerBase):
    """
    The implementation of the SpiNNaker simulation interface.

    .. note::
        You should not normally instantiate this directly from user code.
        Call :py:func:`~spinnaker_graph_front_end.setup` instead.
    """

    def __init__(
            self, n_chips_required: Optional[int] = None,
            n_boards_required: Optional[int] = None,
            time_scale_factor: Optional[int] = None,
            timestep: Optional[int] = None):
        """
        :param n_chips_required:
            How many chips are required.
            *Prefer* `n_boards_required` *if possible.*
        :param n_boards_required:
            How many boards are required. Unnecessary with a local board.
        :param time_scale_factor:
            The time slow-down factor
        :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
        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)

    @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

    @property
    @overrides(AbstractSpinnakerBase._data_writer_cls)
    def _data_writer_cls(self) -> Type[FecDataWriter]:
        return FecDataWriter

    def __repr__(self) -> str:
        if FecDataView.has_ipaddress():
            return (f"SpiNNaker Graph Front End object "
                    f"for machine {FecDataView.get_ipaddress()}")
        else:
            return "SpiNNaker Graph Front End object no machine set"