Metadata-Version: 2.1
Name: sdss-lvmscp
Version: 0.4.0
Summary: LVM spectrograph control package.
Home-page: https://github.com/sdss/lvmscp
License: BSD-3-Clause
Keywords: astronomy,software
Author: José Sánchez-Gallego
Author-email: gallegoj@uw.edu
Maintainer: José Sánchez-Gallego
Maintainer-email: gallegoj@uw.edu
Requires-Python: >=3.8,<3.12
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
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.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: Authlib (>=1.0.0rc1)
Requires-Dist: click (>=8.1.2,<9.0.0)
Requires-Dist: click-default-group (>=1.2.2,<2.0.0)
Requires-Dist: httpx (>=0.18.1)
Requires-Dist: sdss-archon (>=0.8.0,<0.9.0)
Requires-Dist: sdss-clu (>=1.6.1,<2.0.0)
Requires-Dist: sdsstools (>=1.0.0,<2.0.0)
Project-URL: Documentation, https://sdss-lvmscp.readthedocs.org
Project-URL: Repository, https://github.com/sdss/lvmscp
Description-Content-Type: text/markdown

# lvmscp

![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/lvmscp/badge/?version=latest)](https://lvmscp.readthedocs.io/en/latest/?badge=latest)
[![Test](https://github.com/sdss/lvmscp/actions/workflows/test.yml/badge.svg)](https://github.com/sdss/lvmscp/actions/workflows/test.yml)
[![Docker](https://github.com/sdss/lvmscp/actions/workflows/docker.yml/badge.svg)](https://github.com/sdss/lvmscp/actions/workflows/docker.yml)
[![codecov](https://codecov.io/gh/sdss/lvmscp/branch/main/graph/badge.svg?token=RYKAKyfNpZ)](https://codecov.io/gh/sdss/lvmscp)

SDSS-V LVM (Local Volume Mapper) control software for the spectrograph system.

## Quick Start

### Installation

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

`lvmscp` can be installed using `pip`

```console
pip install sdss-lvmscp
```

or by cloning this repository

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

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

```console
cd lvmscp
poetry install
```


### Basic ping-pong test

Start the `lvmscp` actor.

```console
lvmscp start
```

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

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

Stop `lvmscp` actor.

```console
lvmscp stop
```

