Metadata-Version: 2.4
Name: SpiNNMachine
Version: 1!7.4.1
Summary: Representation of a SpiNNaker Machine
Home-page: https://github.com/SpiNNakerManchester/SpiNNMachine
Maintainer: SpiNNakerTeam
Maintainer-email: spinnakerusers@googlegroups.com
License: Apache-2.0
Keywords: spinnaker,machine model
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: <4,>=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSE_POLICY.md
Requires-Dist: SpiNNUtilities==1!7.4.1
Provides-Extra: test
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: testfixtures; extra == "test"
Requires-Dist: httpretty!=1.0.0; extra == "test"
Requires-Dist: deepdiff; extra == "test"
Dynamic: license-file

[![PyPi version](https://img.shields.io/pypi/v/SpiNNMachine.svg?style=flat)](https://pypi.org/project/SpiNNMachine/)
[![Python Actions](https://github.com/SpiNNakerManchester/SpiNNMachine/actions/workflows/python_actions.yml/badge.svg)](https://github.com/SpiNNakerManchester/SpiNNMachine/actions/workflows/python_actions.yml)
[![Documentation Status](https://readthedocs.org/projects/spinnmachine/badge/?version=7.4.1)](https://spinnmachine.readthedocs.io/en/7.4.1)
[![Coverage Status](https://coveralls.io/repos/github/SpiNNakerManchester/SpiNNMachine/badge.svg?branch=master)](https://coveralls.io/github/SpiNNakerManchester/SpiNNMachine?branch=master)

This package is part of the [SpiNNaker Project](http://apt.cs.manchester.ac.uk/projects/SpiNNaker/) .

This package is used to provide a Python representation of a SpiNNaker machine

User Installation
=================
If you want to install for all users, run:

    sudo pip install SpiNNMachine

If you want to install only for yourself, run:

    pip install SpiNNMachine --user

To install in a virtualenv, with the virtualenv enabled, run:

    pip install SpiNNMachine

Developer Installation
======================
If you want to be able to edit the source code, but still have it referenced
from other Python modules, you can set the install to be a developer install.
In this case, download the source code, and extract it locally, or else clone
the git repository:

    git clone http://github.com/SpiNNakerManchester/SpiNNMachine.git

To install as a development version which all users will then be able to use,
run the following where the code has been extracted:

    sudo pip install -e .

To install as a development version for only yourself, run:

    pip install -e . --user

To install as a development version in a `virtualenv`, with the `virutalenv`
enabled, run:

    pip install -e .

Test Installation
=================
To be able to run the unitests add [Test] to the pip installs above

    pip install -e .[Test]

Documentation
=============
[SpiNNMachine python documentation](http://spinnmachine.readthedocs.io/en/7.4.1)

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