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:
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/en/7.4.0)
<br>
[SpiNNFrontEndCommon C documentation](https://spinnfrontendcommon.readthedocs.io/en/7.4.0)
[Combined python documentation](http://spinnakermanchester.readthedocs.io/en/7.4.0)
Raw data
{
"_id": null,
"home_page": "https://github.com/SpiNNakerManchester/SpiNNFrontEndCommon",
"name": "SpiNNFrontEndCommon",
"maintainer": "SpiNNakerTeam",
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": "spinnakerusers@googlegroups.com",
"keywords": "spinnaker",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/41/73/6eca0c2e1285816e17ab07e4edfbd4ff7db527c0020f979971e9e16a77cd/spinnfrontendcommon-1!7.4.0.tar.gz",
"platform": null,
"description": "\nThis package provides functionality which are common to front ends that\ntranslate application level programs into executables which run on a SpiNNaker\nmachine.\n\nRequirements\n============\n\nIn addition to a standard Python installation, this package depends on:\n\n numpy\n SpiNNUtilities\n SpiNNMachine\n PACMAN\n SpiNNMan\n spalloc\n\nThese dependencies can be installed using `pip`:\n\n pip install numpy\n pip install SpiNNUtilities SpiNNMachine PACMAN SpiNNMan spalloc\n\nIf you want to use the `spinnaker_router_provenance_mapper` command line tool\nto visualise the traffic on SpiNNaker boards caused by your simulations, you\nshould install this package using:\n\n pip install \"SpiNNFrontEndCommon[plotting]\"\n\nThis will additionally install `matplotlib` and `seaborn` to do the actual\nplotting, as well as configuring the script.\n\nVisualising SpiNNaker Board Network Traffic\n===========================================\n\nTo get plots of the traffic in your simulation, use the\n`spinnaker_router_provenance_mapper` command line tool (installed as described\nabove), passing in the name of a provenance database (usually called\n`provenance.sqlite3` and created within the run's reporting folders) that\ncontains the raw data. This will produce a number of graphs as images in your\ncurrent directory; _those have fixed file-names._\n\n spinnaker_router_provenance_mapper my_code/.../provenance.sqlite3\n\nAn example of the sort of map that might be produced is:\n\n\n\nThe P2P traffic being mapped is mainly used for system boot and control.\nThe white square is due to a chip on that SpiNNaker board being marked as\ndeactivated.\n\nDocumentation\n=============\n[SpiNNFrontEndCommon python documentation](https://spinnfrontendcommon.readthedocs.io/en/7.4.0)\n<br>\n[SpiNNFrontEndCommon C documentation](https://spinnfrontendcommon.readthedocs.io/en/7.4.0)\n\n[Combined python documentation](http://spinnakermanchester.readthedocs.io/en/7.4.0)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Common SpiNNaker Front end functions",
"version": "1!7.4.0",
"project_urls": {
"Homepage": "https://github.com/SpiNNakerManchester/SpiNNFrontEndCommon"
},
"split_keywords": [
"spinnaker"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "202244c1473d463c6df9d18c9cc4f99024122f30429723a4e074734d1e9ba85d",
"md5": "05e0ca713397de1cf0978dd94056d6cd",
"sha256": "f60446197bd7a6c0dd242bdaf03f74558ee182bff2d74a864bf0dc87a02ca7aa"
},
"downloads": -1,
"filename": "spinnfrontendcommon-1!7.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "05e0ca713397de1cf0978dd94056d6cd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 451129,
"upload_time": "2025-10-14T05:50:47",
"upload_time_iso_8601": "2025-10-14T05:50:47.742514Z",
"url": "https://files.pythonhosted.org/packages/20/22/44c1473d463c6df9d18c9cc4f99024122f30429723a4e074734d1e9ba85d/spinnfrontendcommon-1!7.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "41736eca0c2e1285816e17ab07e4edfbd4ff7db527c0020f979971e9e16a77cd",
"md5": "7e0a934ebc42c597ec53aac72676aade",
"sha256": "264955cf9100d763c37c47ac777cf52d3e4b06c84f7603951c09b0f7a5040b8b"
},
"downloads": -1,
"filename": "spinnfrontendcommon-1!7.4.0.tar.gz",
"has_sig": false,
"md5_digest": "7e0a934ebc42c597ec53aac72676aade",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 277029,
"upload_time": "2025-10-14T05:50:49",
"upload_time_iso_8601": "2025-10-14T05:50:49.585380Z",
"url": "https://files.pythonhosted.org/packages/41/73/6eca0c2e1285816e17ab07e4edfbd4ff7db527c0020f979971e9e16a77cd/spinnfrontendcommon-1!7.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-14 05:50:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SpiNNakerManchester",
"github_project": "SpiNNFrontEndCommon",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "spinnfrontendcommon"
}
JSON
