# Source code for spinnman.utilities.reports

# Copyright (c) 2017-2019 The University of Manchester
#
# This program is free software: you can redistribute it and/or modify
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import os.path
import time
import logging

_REPORT_NAME = "machine_structure.rpt"

[docs]def generate_machine_report(report_directory, machine, connections):
""" Generate report on the physical structure of the target SpiNNaker \
machine.

:param str report_directory: the directory to which reports are stored
:param ~spinn_machine.Machine machine: the machine python object
:param list(Connection) connections:
the list of connections to the machine
:raise IOError: when a file cannot be opened for some reason
"""
file_name = os.path.join(report_directory, _REPORT_NAME)
time_date_string = time.strftime("%c")
try:
with open(file_name, "w") as f:
# TODO: Add further details on the target machine.
for chip in machine.chips:
_write_chip_router_report(f, chip)
except IOError:
logger.exception(
"Generate_placement_reports: Can't open file {} for writing.",
file_name)
raise

"""
:param str timestamp:
:param ~spinn_machine.Machine machine:
:param list(Connection) connections:
"""
f.write("\t\tTarget SpiNNaker Machine Structure\n")
f.write("\t\t==================================\n")
f.write("\nGenerated: {} for target machine '{}'\n\n".format(
timestamp, connections))
f.write("Machine dimensions (in chips) x : {}  y : {}\n\n".format(
machine.width, machine.height))
f.write("\t\tMachine router information\n")
f.write("\t\t==========================\n")

def _write_chip_router_report(f, chip):
"""
:param ~spinn_machine.Chip chip:
"""
f.write("\nInformation for chip {}:{}\n".format(chip.x, chip.y))
f.write("Neighbouring chips \n{}\n".format(
chip.router.get_neighbouring_chips_coords()))
f.write("Router list of links for this chip are: \n")