spinnfrontendcommon

Common support code for user-facing front end systems.

https://github.com/spinnakermanchester/spinnfrontendcommon

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    15 of 24 committers (62.5%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.9%) to scientific vocabulary

Keywords

c python spinnaker

Keywords from Contributors

machine-interface examples
Last synced: 6 months ago · JSON representation ·

Repository

Common support code for user-facing front end systems.

Basic Info
  • Host: GitHub
  • Owner: SpiNNakerManchester
  • License: apache-2.0
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 41.3 MB
Statistics
  • Stars: 12
  • Watchers: 17
  • Forks: 11
  • Open Issues: 94
  • Releases: 5
Topics
c python spinnaker
Created over 11 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

PyPi version Python Build Status C Build Status Documentation Status Coverage Status

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

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
SpiNNFrontEndCommon C documentation

Combined python documentation

Owner

  • Name: SpiNNaker - University of Manchester
  • Login: SpiNNakerManchester
  • Kind: organization
  • Email: spinnakerusers@googlegroups.com
  • Location: Manchester, UK

Software for the SpiNNaker Million Core Neuromorphic Machine. Part of the Human Brain Project and EBRAINS

Citation (CITATION.cff)

# Copyright (c) 2017 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.

cff-version: 1.2.0
message: If you use this software, please cite it as below.
preferred-citation:
  type: article
  doi: 10.3389/fnins.2019.00231
  issn: 1662-453X
  url: https://www.frontiersin.org/articles/10.3389/fnins.2019.00231
  title: "SpiNNTools: The Execution Engine for the SpiNNaker Platform"
  journal: Frontiers in Neuroscience
  volume: 13
  year: 2019
  month: 3
  abstract: SpiNNaker is a massively parallel distributed architecture primarily focused on real time simulation of spiking neural networks. The largest realization of the architecture consists of one million general purpose processors, making it the largest neuromorphic computing platform in the world at the present time. Utilizing these processors efficiently requires expert knowledge of the architecture to generate executable code and to harness the potential of the unique inter-processor communications infra-structure that lies at the heart of the SpiNNaker architecture. This work introduces a software suite called SpiNNTools that can map a computational problem described as a graph into the required set of executables, application data and routing information necessary for simulation on this novel machine. The SpiNNaker architecture is highly scalable, giving rise to unique challenges in mapping the problem to the machines resources, loading the generated files to the machine and subsequently retrieving the results of simulation. In this paper we describe these challenges in detail and the solutions implemented.
  authors:
  - given-names: Andrew
    family-names: Rowley
    affiliation: University Of Manchester
    email: Andrew.Rowley@manchester.ac.uk
    orcid: https://orcid.org/0000-0002-2646-8520
    website: https://www.researchgate.net/profile/Andrew_Rowley2
  - given-names: Christian Y.
    family-names: Brenninkmeijer
    affiliation: University Of Manchester
    email: christian.brenninkmeijer@manchester.ac.uk
    orcid: https://orcid.org/0000-0002-2937-7819
    website: https://www.researchgate.net/profile/Christian_Brenninkmeijer
  - given-names: Simon
    family-names: Davidson
    affiliation: University Of Manchester
    orcid: https://orcid.org/0000-0001-5385-442X
    website: https://research.manchester.ac.uk/en/persons/simon.davidson
  - given-names: Donal
    family-names: Fellows
    affiliation: University Of Manchester
    orcid: https://orcid.org/0000-0002-9091-5938
    website: https://www.researchgate.net/profile/Donal-Fellows
  - given-names: Andrew
    family-names: Gait
    affiliation: University Of Manchester
    orcid: https://orcid.org/0000-0001-9349-1096
    website: https://personalpages.manchester.ac.uk/staff/andrew.gait/
  - given-names: David R.
    family-names: Lester
    affiliation: University Of Manchester
    orcid: https://orcid.org/0000-0002-7267-291X
  - given-names: Luis A.
    family-names: Plana
    affiliation: University Of Manchester
    orcid: https://orcid.org/0000-0002-6113-3929
    website: https://research.manchester.ac.uk/en/persons/luis.plana
  - given-names: Oliver
    family-names: Rhodes
    affiliation: University Of Manchester
    orcid: https://orcid.org/0000-0003-1728-2828
    website: https://research.manchester.ac.uk/en/persons/oliver.rhodes
  - given-names: Alan B.
    family-names: Stokes
    affiliation: University Of Manchester
    orcid: https://orcid.org/0000-0002-6110-1484
  - given-names: Steve B.
    family-names: Furber
    affiliation: University Of Manchester
    orcid: https://orcid.org/0000-0002-6524-3367
    website: https://research.manchester.ac.uk/en/persons/steve.furber

title: The Common code for supporting all front ends on mapping applications to run
authors:
    - name: SpiNNaker Software Team
      alias: For a list of contributors see https://github.com/SpiNNakerManchester/SpiNNFrontEndCommon/graphs/contributors or for a combined list see https://spinnakermanchester.github.io/latest/LicenseAgreement.html#contributors
      address: University of Manchester, Oxford Road
      city: Manchester
      country: GB
      email: spinnakerusers@googlegroups.com
      post-code: M13 9PL
      website: https://apt.cs.manchester.ac.uk/projects/SpiNNaker/
url: https://spinnakermanchester.github.io/
contact:
- address: University of Manchester, Oxford Road
  city: Manchester
  country: GB
  email: spinnakerusers@googlegroups.com
  name: SpiNNaker Software Team
  post-code: M13 9PL
license: Apache-2.0
repository: https://github.com/SpiNNakerManchester/SpiNNFrontEndCommon

GitHub Events

Total
  • Issues event: 21
  • Delete event: 53
  • Issue comment event: 29
  • Push event: 269
  • Pull request review comment event: 6
  • Pull request review event: 15
  • Pull request event: 93
  • Create event: 62
Last Year
  • Issues event: 21
  • Delete event: 53
  • Issue comment event: 29
  • Push event: 269
  • Pull request review comment event: 6
  • Pull request review event: 15
  • Pull request event: 93
  • Create event: 62

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 5,386
  • Total Committers: 24
  • Avg Commits per committer: 224.417
  • Development Distribution Score (DDS): 0.601
Top Committers
Name Email Commits
Christian Y. Brenninkmeijer c****r@m****k 2,151
alan-stokes a****s@g****m 1,115
Andrew Rowley A****y@m****k 1,043
Donal Fellows d****s@m****k 745
Christian b****c@c****k 141
Andrew Gait a****t@m****k 94
daviess s****s@g****m 27
mbassor2 m****2@c****k 16
test t****t@t****m 10
oliverrhodes o****s@m****k 6
Felix Schneider f****d@f****e 6
jofas j****s@f****e 6
james.knight j****5@p****k 4
sergiodavies d****s@c****k 4
Petrut Antoniu Bogdan p****n@p****k 3
Paul92 p****n@g****m 3
Petrut Antoniu Bogdan p****n@s****k 3
basab b****b@m****k 2
jamie n****e@g****m 2
andrewgait a****t@i****e 1
zzalsar4 z****4@z****4 1
dr-david-lester d****r@c****k 1
Petrut Antoniu Bogdan p****n@m****k 1
rjames91 r****s@m****k 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 97
  • Total pull requests: 330
  • Average time to close issues: about 2 years
  • Average time to close pull requests: 3 months
  • Total issue authors: 10
  • Total pull request authors: 6
  • Average comments per issue: 1.69
  • Average comments per pull request: 0.57
  • Merged pull requests: 246
  • Bot issues: 0
  • Bot pull requests: 19
Past Year
  • Issues: 17
  • Pull requests: 97
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 7 days
  • Issue authors: 2
  • Pull request authors: 3
  • Average comments per issue: 0.47
  • Average comments per pull request: 0.18
  • Merged pull requests: 74
  • Bot issues: 0
  • Bot pull requests: 9
Top Authors
Issue Authors
  • Christian-B (61)
  • rowleya (19)
  • alan-stokes (4)
  • dkfellows (4)
  • andrewgait (2)
  • rjames91 (2)
  • lplana (2)
  • chanokin (1)
  • jofas (1)
  • arrenglover (1)
Pull Request Authors
  • Christian-B (280)
  • rowleya (70)
  • dependabot[bot] (24)
  • dkfellows (21)
  • alan-stokes (7)
  • andrewgait (6)
Top Labels
Issue Labels
enhancement (29) bug (21) question (10) minor (10) reporting/provenance (10) C (6) wontfix (2) incomplete_left_for_further_release (2) next_release (1) help wanted (1) blocker (1)
Pull Request Labels
enhancement (61) dependencies (24) bug (19) blocker (16) minor (10) incomplete_left_for_further_release (6) reporting/provenance (6) C (5) in progress (5) historic (4) invalid (2) wontfix (1)

Dependencies

.github/workflows/c_actions.yml actions
  • ./support/actions/apt-get-install * composite
  • ./support/actions/checkout-spinn-deps * composite
  • ./support/actions/vera * composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/publish.yml actions
  • ./support/actions/checkout-spinn-deps * composite
  • ./support/actions/python-tools * composite
  • ./support/actions/run-setup * composite
  • ./support/actions/sphinx * composite
  • JamesIves/github-pages-deploy-action 3.7.1 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • mattnotmitt/doxygen-action v1.3.1 composite
.github/workflows/python_actions.yml actions
  • ./support/actions/check-copyrights * composite
  • ./support/actions/checkout-spinn-deps * composite
  • ./support/actions/pylint * composite
  • ./support/actions/pytest * composite
  • ./support/actions/python-tools * composite
  • ./support/actions/run-setup * composite
  • ./support/actions/sphinx * composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
setup.py pypi
  • SpiNNMachine *
  • SpiNNMan *
  • SpiNNUtilities *
  • SpiNNaker_DataSpecification *
  • SpiNNaker_PACMAN *
  • requests *
  • scipy *
  • spalloc *
doc/doc_requirements.txt pypi
pyproject.toml pypi