sdss-lvmieb


Namesdss-lvmieb JSON
Version 0.5.3 PyPI version JSON
download
home_pagehttps://github.com/sdss/lvmieb
SummaryControl software for the Local Volume Mapper Instrument Electronics Box
upload_time2024-01-13 19:12:47
maintainerJosé Sánchez-Gallego
docs_urlNone
authorChanggon Kim
requires_python>=3.9,<3.13
licenseBSD-3-Clause
keywords astronomy software
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # lvmieb

![Versions](https://img.shields.io/badge/python->3.8-blue)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Documentation Status](https://readthedocs.org/projects/lvmieb/badge/?version=latest)](https://lvmieb.readthedocs.io/en/latest/?badge=latest)
[![Test](https://github.com/sdss/lvmieb/actions/workflows/test.yml/badge.svg)](https://github.com/sdss/lvmieb/actions/workflows/test.yml)
[![Docker](https://github.com/sdss/lvmieb/actions/workflows/docker.yml/badge.svg)](https://github.com/sdss/lvmieb/actions/workflows/docker.yml)
[![codecov](https://codecov.io/gh/sdss/lvmieb/branch/main/graph/badge.svg?token=IyQglaQYSF)](https://codecov.io/gh/sdss/lvmieb)

Control software for the SDSS-V LVM (Local Volume Mapper) spectrograph Instrument Electronics Box (IEB).

## Quick Start

### Installation

`lvmieb` uses the [CLU](https://clu.readthedocs.io/en/latest/) framework and requires a RabbitMQ instance running in the background.

`lvmieb` can be installed using `pip`

```console
pip install sdss-lvmieb
```

or by cloning this repository

```console
git clone https://github.com/sdss/lvmieb
```

The preferred installation for development is using [poetry](https://python-poetry.org/)

```console
cd lvmieb
poetry install
```


### Basic ping-pong test

Start the `lvmieb` actor.

```console
lvmieb start
```

In another terminal, type `clu` and `lvmieb ping` for test.

```console
$ clu
lvmieb ping
07:41:22.636 lvmieb >
07:41:22.645 lvmieb : {
    "text": "Pong."
}
```

Stop `lvmieb` actor.

```console
lvmieb stop
```

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/sdss/lvmieb",
    "name": "sdss-lvmieb",
    "maintainer": "Jos\u00e9 S\u00e1nchez-Gallego",
    "docs_url": null,
    "requires_python": ">=3.9,<3.13",
    "maintainer_email": "gallegoj@uw.edu",
    "keywords": "astronomy,software",
    "author": "Changgon Kim",
    "author_email": "changgonkim@khu.ac.kr",
    "download_url": "https://files.pythonhosted.org/packages/2b/4e/5d62f278d4960471b0a6c6188268a96e22dcf487ad7c5d6028822ed1e589/sdss_lvmieb-0.5.3.tar.gz",
    "platform": null,
    "description": "# lvmieb\n\n![Versions](https://img.shields.io/badge/python->3.8-blue)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Documentation Status](https://readthedocs.org/projects/lvmieb/badge/?version=latest)](https://lvmieb.readthedocs.io/en/latest/?badge=latest)\n[![Test](https://github.com/sdss/lvmieb/actions/workflows/test.yml/badge.svg)](https://github.com/sdss/lvmieb/actions/workflows/test.yml)\n[![Docker](https://github.com/sdss/lvmieb/actions/workflows/docker.yml/badge.svg)](https://github.com/sdss/lvmieb/actions/workflows/docker.yml)\n[![codecov](https://codecov.io/gh/sdss/lvmieb/branch/main/graph/badge.svg?token=IyQglaQYSF)](https://codecov.io/gh/sdss/lvmieb)\n\nControl software for the SDSS-V LVM (Local Volume Mapper) spectrograph Instrument Electronics Box (IEB).\n\n## Quick Start\n\n### Installation\n\n`lvmieb` uses the [CLU](https://clu.readthedocs.io/en/latest/) framework and requires a RabbitMQ instance running in the background.\n\n`lvmieb` can be installed using `pip`\n\n```console\npip install sdss-lvmieb\n```\n\nor by cloning this repository\n\n```console\ngit clone https://github.com/sdss/lvmieb\n```\n\nThe preferred installation for development is using [poetry](https://python-poetry.org/)\n\n```console\ncd lvmieb\npoetry install\n```\n\n\n### Basic ping-pong test\n\nStart the `lvmieb` actor.\n\n```console\nlvmieb start\n```\n\nIn another terminal, type `clu` and `lvmieb ping` for test.\n\n```console\n$ clu\nlvmieb ping\n07:41:22.636 lvmieb >\n07:41:22.645 lvmieb : {\n    \"text\": \"Pong.\"\n}\n```\n\nStop `lvmieb` actor.\n\n```console\nlvmieb stop\n```\n\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Control software for the Local Volume Mapper Instrument Electronics Box",
    "version": "0.5.3",
    "project_urls": {
        "Documentation": "https://sdss-lvmieb.readthedocs.org",
        "Homepage": "https://github.com/sdss/lvmieb",
        "Repository": "https://github.com/sdss/lvmieb"
    },
    "split_keywords": [
        "astronomy",
        "software"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a4f786efe8162e057d9d4f95ebe6ceeb9deb703c740f26deedea31805d71e626",
                "md5": "9a5290e6367432ccb5597640df45ffd5",
                "sha256": "18aea3677a323a4d0941447d55543cbf74721c50486e310a8e5678c5af120f24"
            },
            "downloads": -1,
            "filename": "sdss_lvmieb-0.5.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9a5290e6367432ccb5597640df45ffd5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<3.13",
            "size": 21965,
            "upload_time": "2024-01-13T19:12:45",
            "upload_time_iso_8601": "2024-01-13T19:12:45.515990Z",
            "url": "https://files.pythonhosted.org/packages/a4/f7/86efe8162e057d9d4f95ebe6ceeb9deb703c740f26deedea31805d71e626/sdss_lvmieb-0.5.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2b4e5d62f278d4960471b0a6c6188268a96e22dcf487ad7c5d6028822ed1e589",
                "md5": "1fdf16873c5a807f3340d103d0d3df1c",
                "sha256": "de17f856d4b55def0b26a02dbf549e9187cbcbc958a9a1584632bc6aebc1f5b6"
            },
            "downloads": -1,
            "filename": "sdss_lvmieb-0.5.3.tar.gz",
            "has_sig": false,
            "md5_digest": "1fdf16873c5a807f3340d103d0d3df1c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<3.13",
            "size": 14926,
            "upload_time": "2024-01-13T19:12:47",
            "upload_time_iso_8601": "2024-01-13T19:12:47.132930Z",
            "url": "https://files.pythonhosted.org/packages/2b/4e/5d62f278d4960471b0a6c6188268a96e22dcf487ad7c5d6028822ed1e589/sdss_lvmieb-0.5.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-13 19:12:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sdss",
    "github_project": "lvmieb",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "sdss-lvmieb"
}
Changgon Kim
Elapsed time: 0.16352s