Metadata-Version: 2.3
Name: sdss-lvmieb
Version: 0.6.0
Summary: Control software for the Local Volume Mapper Instrument Electronics Box
Keywords: astronomy,software
Author: Changgon Kim, José Sánchez-Gallego
Author-email: Changgon Kim <changgonkim@khu.ac.kr>, José Sánchez-Gallego <gallegoj@uw.edu>
License: BSD-3-Clause
Requires-Dist: sdsstools>=1.9.7
Requires-Dist: sdss-clu>=2.0.0
Requires-Dist: numpy>=2.0.0
Requires-Dist: sdss-drift>=1.1.0
Requires-Dist: ipython>=7.11.0 ; extra == 'dev'
Requires-Dist: doc8>=0.8.0 ; extra == 'dev'
Requires-Dist: pytest>=5.2.2 ; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.10.0 ; extra == 'dev'
Requires-Dist: pytest-cov>=2.8.1 ; extra == 'dev'
Requires-Dist: pytest-mock>=1.13.0 ; extra == 'dev'
Requires-Dist: pytest-sugar>=0.9.2 ; extra == 'dev'
Requires-Dist: coverage[toml]>=5.0 ; extra == 'dev'
Requires-Dist: ipdb>=0.12.3 ; extra == 'dev'
Requires-Dist: rstcheck>=3.3.1 ; extra == 'dev'
Requires-Dist: sphinx>=3.0.0 ; extra == 'dev'
Requires-Dist: sphinx-click>=2.6.0 ; extra == 'dev'
Requires-Dist: sphinx-jsonschema>=1.16.7 ; extra == 'dev'
Requires-Dist: myst-parser>=0.14.0 ; extra == 'dev'
Requires-Dist: furo>=2021.6.18 ; extra == 'dev'
Requires-Dist: nox>=2021.6.12 ; extra == 'dev'
Requires-Dist: sphinx-autobuild>=2021.3.14 ; extra == 'dev'
Requires-Dist: sphinx-copybutton>=0.3.3 ; extra == 'dev'
Requires-Dist: ruff>=0.0.289 ; extra == 'dev'
Requires-Python: >=3.10, <4
Project-URL: Homepage, https://github.com/sdss/lvmieb
Project-URL: Repository, https://github.com/sdss/lvmieb
Project-URL: Documentation, https://sdss-lvmieb.readthedocs.org
Provides-Extra: dev
Description-Content-Type: text/markdown

# 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 [uv](https://docs.astral.sh/uv/)

```console
cd lvmieb
uv sync --all-groups --all-extras
```

### Basic ping-pong test

Start the `lvmieb` actor.

```console
lvmieb start --debug
```

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
```
