Metadata-Version: 2.5
Name: pyaml-cs-oa
Version: 0.2.0a1
Summary: PyAML control system plugin for ophyd-async
Maintainer-email: Yoshiteru Hidaka <yhidaka@bnl.gov>
License-File: LICENSE
Keywords: Accelerator,Commissioning,Digital Twin,EPICS,Operation,Synchrotron,Tango,Tuning
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.11
Requires-Dist: accelerator-middle-layer>=0.2.2
Requires-Dist: ophyd-async
Requires-Dist: pydantic>=2.0
Provides-Extra: dev
Requires-Dist: copier; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: ophyd-async[ca,pva]; extra == 'dev'
Requires-Dist: ophyd-async[tango]; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Provides-Extra: docs-extra
Requires-Dist: ophyd-async[ca,pva]; extra == 'docs-extra'
Requires-Dist: ophyd-async[tango]; extra == 'docs-extra'
Provides-Extra: epics
Requires-Dist: ophyd-async[ca,pva]; extra == 'epics'
Provides-Extra: tango
Requires-Dist: ophyd-async[tango]; extra == 'tango'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Description-Content-Type: text/markdown

# pyaml-cs-oa

**PyAML control system bindings using ophyd-async**

[![Documentation Status](https://readthedocs.org/projects/pyaml-cs-oa/badge/?version=latest)](https://pyaml-cs-oa.readthedocs.io/en/latest/?badge=latest)
[![Current release](https://img.shields.io/github/v/release/python-accelerator-middle-layer/pyaml-cs-oa)](https://github.com/python-accelerator-middle-layer/pyaml-cs-oa/releases)

## Overview

`pyaml-cs-oa` provides `pyAML` control-system bindings using `ophyd-async`. It currently supports EPICS and Tango control systems.

## Installation

Install the package from PyPI:

```bash
pip install pyaml-cs-oa
```

**EPICS CA/PVA Support**

```bash
pip install pyaml-cs-oa[epics]
```

This adds the EPICS channel and PV access dependencies.

**TANGO Support**

```bash
pip install pyaml-cs-oa[tango]
```

This adds the TANGO dependencies.

## Development

Install the development dependencies with:

```bash
pip install pyaml-cs-oa[dev]
```

Run the test suite with:

```bash
pytest
```

Install the pre-commit hooks with:

```bash
pre-commit install
```

## Documentation

The documentation is available at:

<https://pyaml-cs-oa.readthedocs.io/en/stable/>

## Contributing

Please use the issue tracker or submit a pull request.
