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)
Raw data
{
"_id": null,
"home_page": "https://github.com/SpiNNakerManchester/spalloc",
"name": "spalloc",
"maintainer": "SpiNNakerTeam",
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": "spinnakerusers@googlegroups.com",
"keywords": "spinnaker, allocation, packing management, supercomputer",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/17/d6/01dc49290ac7e24d556a03fb3915652d369bc12cfe28a013f0c7aaa659c9/spalloc-1!7.2.1.tar.gz",
"platform": null,
"description": "Spalloc: SpiNNaker machine allocation client\n============================================\n\n.. image:: https://img.shields.io/pypi/v/spalloc.svg?style=flat\n :alt: PyPi version\n :target: https://pypi.python.org/pypi/spalloc/\n.. image:: https://readthedocs.org/projects/spalloc/badge/?version=stable\n :alt: Documentation\n :target: https://spalloc.readthedocs.org/\n.. image:: https://github.com/SpiNNakerManchester/spalloc/workflows/Python%20Build/badge.svg?branch=master\n :alt: Build Status\n :target: https://github.com/SpiNNakerManchester/spalloc/actions?query=workflow%3A%22Python+Build%22+branch%3Amaster\n.. image:: https://coveralls.io/repos/SpiNNakerManchester/spalloc/badge.svg?branch=master\n :alt: Coverage Status\n :target: https://coveralls.io/r/SpiNNakerManchester/spalloc?branch=master\n\nSpalloc is a Python library and set of command-line programs for requesting\nSpiNNaker_ machines from a spalloc `server`_.\n\n.. _SpiNNaker: https://apt.cs.manchester.ac.uk/projects/SpiNNaker/\n.. _server: https://github.com/SpiNNakerManchester/spalloc_server\n\nTo get started, see the quick-start below or refer to the documentation_.\n\n.. _documentation: https://spalloc.readthedocs.org/\n\n\nQuick-start\n-----------\n\n**Step 1: Install spalloc**::\n\n $ pip install spalloc\n\n**Step 2: Write a configuration file** indicating your email address and the spalloc\nserver's address (run ``python -m spalloc.config`` to discover what to call\nyour config file on your machine)::\n\n [spalloc]\n hostname = my_server\n owner = jdh@cs.man.ac.uk\n\n**Step 3: Request a system** using the command-line interface, e.g. a\nthree-board machine::\n\n $ spalloc 3\n\n.. image:: docs/source/_static/spalloc.gif\n :alt: Animated GIF showing the typical execution of a spalloc call.\n\n...or request one from Python...\n\n::\n\n >>> from spalloc_client import Job\n >>> with Job(3) as j:\n ... my_boot(j.hostname, j.width, j.height)\n ... my_application(j.hostname)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A client for the spalloc_server SpiNNaker machine partitioning and allocation system.",
"version": "1!7.2.1",
"project_urls": {
"Homepage": "https://github.com/SpiNNakerManchester/spalloc"
},
"split_keywords": [
"spinnaker",
" allocation",
" packing management",
" supercomputer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4069a352c0cae4950651a737016bb6437a6a3a1b60481f6b430f1128985b01a3",
"md5": "52d06a712f4f7b127b96c3315e811ae4",
"sha256": "8a0a06a786f859c117bc9e288611064ae57d3d2c7ee0a7e0ffa9820e6b43a363"
},
"downloads": -1,
"filename": "spalloc-1!7.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "52d06a712f4f7b127b96c3315e811ae4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 56245,
"upload_time": "2024-08-12T11:37:34",
"upload_time_iso_8601": "2024-08-12T11:37:34.262969Z",
"url": "https://files.pythonhosted.org/packages/40/69/a352c0cae4950651a737016bb6437a6a3a1b60481f6b430f1128985b01a3/spalloc-1!7.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "17d601dc49290ac7e24d556a03fb3915652d369bc12cfe28a013f0c7aaa659c9",
"md5": "b0b059e484868468742961cdf5d9be48",
"sha256": "3505cc154d189a4834aec96a5cadc2a2f0700632d1d738c6b416b8ae121df9b2"
},
"downloads": -1,
"filename": "spalloc-1!7.2.1.tar.gz",
"has_sig": false,
"md5_digest": "b0b059e484868468742961cdf5d9be48",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 52028,
"upload_time": "2024-08-12T11:37:36",
"upload_time_iso_8601": "2024-08-12T11:37:36.833877Z",
"url": "https://files.pythonhosted.org/packages/17/d6/01dc49290ac7e24d556a03fb3915652d369bc12cfe28a013f0c7aaa659c9/spalloc-1!7.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-12 11:37:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SpiNNakerManchester",
"github_project": "spalloc",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "spalloc"
}
JSON
