Metadata-Version: 2.1
Name: spalloc
Version: 1!7.0.0a4
Summary: A client for the spalloc_server SpiNNaker machine partitioning and allocation system.
Home-page: https://github.com/SpiNNakerManchester/spalloc
Maintainer: SpiNNakerTeam
Maintainer-email: spinnakerusers@googlegroups.com
License: Apache-2.0
Keywords: spinnaker,allocation,packing management,supercomputer
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
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.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: <4,>=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: LICENSE_POLICY.md
Requires-Dist: jsonschema
Requires-Dist: SpiNNUtilities (==1!7.0.0.a4)
Provides-Extra: test
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: mock ; extra == 'test'

Spalloc: SpiNNaker machine allocation client
============================================

.. image:: https://img.shields.io/pypi/v/spalloc.svg?style=flat
   :alt: PyPi version
   :target: https://pypi.python.org/pypi/spalloc/
.. image:: https://readthedocs.org/projects/spalloc/badge/?version=stable
   :alt: Documentation
   :target: https://spalloc.readthedocs.org/
.. image:: https://github.com/SpiNNakerManchester/spalloc/workflows/Python%20Build/badge.svg?branch=master
   :alt: Build Status
   :target: https://github.com/SpiNNakerManchester/spalloc/actions?query=workflow%3A%22Python+Build%22+branch%3Amaster
.. image:: https://coveralls.io/repos/SpiNNakerManchester/spalloc/badge.svg?branch=master
   :alt: Coverage Status
   :target: https://coveralls.io/r/SpiNNakerManchester/spalloc?branch=master

Spalloc is a Python library and set of command-line programs for requesting
SpiNNaker_ machines from a spalloc `server`_.

.. _SpiNNaker: https://apt.cs.manchester.ac.uk/projects/SpiNNaker/
.. _server: https://github.com/SpiNNakerManchester/spalloc_server

To get started, see the quick-start below or refer to the documentation_.

.. _documentation: https://spalloc.readthedocs.org/


Quick-start
-----------

**Step 1: Install spalloc**::

    $ pip install spalloc

**Step 2: Write a configuration file** indicating your email address and the spalloc
server's address (run ``python -m spalloc.config`` to discover what to call
your config file on your machine)::

    [spalloc]
    hostname = my_server
    owner = jdh@cs.man.ac.uk

**Step 3: Request a system** using the command-line interface, e.g. a
three-board machine::

    $ spalloc 3

.. image:: docs/source/_static/spalloc.gif
    :alt: Animated GIF showing the typical execution of a spalloc call.

...or request one from Python...

::

    >>> from spalloc_client import Job
    >>> with Job(3) as j:
    ...     my_boot(j.hostname, j.width, j.height)
    ...     my_application(j.hostname)
