https://github.com/spinnakermanchester/spinnfrontendcommon

Common support code for user-facing front end systems.
https://github.com/spinnakermanchester/spinnfrontendcommon

c python spinnaker

Last synced: about 1 year ago
JSON representation

Common support code for user-facing front end systems.

• Host: GitHub
• URL: https://github.com/spinnakermanchester/spinnfrontendcommon
• Owner: SpiNNakerManchester
• License: apache-2.0
• Created: 2014-11-04T11:40:07.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2025-04-11T09:32:42.000Z (about 1 year ago)
• Last Synced: 2025-04-11T15:49:31.993Z (about 1 year ago)
• Topics: c, python, spinnaker
• Language: Python
• Homepage:
• Size: 41.1 MB
• Stars: 12
• Watchers: 17
• Forks: 11
• Open Issues: 90
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

          
[![PyPi version](https://img.shields.io/pypi/v/SpiNNFrontEndCommon.svg?style=flat)](https://pypi.org/project/SpiNNFrontEndCommon/)

[![Python Build Status](https://github.com/SpiNNakerManchester/SpiNNFrontEndCommon/workflows/Python%20Actions/badge.svg?branch=master)](https://github.com/SpiNNakerManchester/SpiNNFrontEndCommon/actions?query=workflow%3A%22Python+Actions%22+branch%3Amaster)

[![C Build Status](https://github.com/SpiNNakerManchester/SpiNNFrontEndCommon/workflows/C%20Actions/badge.svg?branch=master)](https://github.com/SpiNNakerManchester/SpiNNFrontEndCommon/actions?query=workflow%3A%22C+Actions%22+branch%3Amaster)

[![Documentation Status](https://readthedocs.org/projects/spinnfrontendcommon/badge/?version=latest)](https://spinnfrontendcommon.readthedocs.io/en/latest/?badge=latest)

[![Coverage Status](https://coveralls.io/repos/github/SpiNNakerManchester/SpiNNFrontEndCommon/badge.svg?branch=master)](https://coveralls.io/github/SpiNNakerManchester/SpiNNFrontEndCommon?branch=master)

This package provides functionality which are common to front ends that

translate application level programs into executables which run on a SpiNNaker

machine.

Requirements

============

In addition to a standard Python installation, this package depends on:

    numpy

    SpiNNUtilities

    SpiNNMachine

    PACMAN

    SpiNNMan

    spalloc

These dependencies can be installed using `pip`:

    pip install numpy

    pip install SpiNNUtilities SpiNNMachine PACMAN SpiNNMan spalloc

If you want to use the `spinnaker_router_provenance_mapper` command line tool

to visualise the traffic on SpiNNaker boards caused by your simulations, you

should install this package using:

    pip install "SpiNNFrontEndCommon[plotting]"

This will additionally install `matplotlib` and `seaborn` to do the actual

plotting, as well as configuring the script.

Visualising SpiNNaker Board Network Traffic

===========================================

To get plots of the traffic in your simulation, use the

`spinnaker_router_provenance_mapper` command line tool (installed as described

above), passing in the name of a provenance database (usually called

`provenance.sqlite3` and created within the run's reporting folders) that

contains the raw data. This will produce a number of graphs as images in your

current directory; _those have fixed file-names._

    spinnaker_router_provenance_mapper my_code/.../provenance.sqlite3

An example of the sort of map that might be produced is:

![External_P2P_Packets](.images/External_P2P_Packets.png)

The P2P traffic being mapped is mainly used for system boot and control.

The white square is due to a chip on that SpiNNaker board being marked as

deactivated.

Documentation

=============

[SpiNNFrontEndCommon python documentation](https://spinnfrontendcommon.readthedocs.io)




[SpiNNFrontEndCommon C documentation](http://spinnakermanchester.github.io/SpiNNFrontEndCommon/c/)

[Combined python documentation](http://spinnakermanchester.readthedocs.io)