pyaml#

Package for the Python Accelerator Middle Layer core

Documentation Status Latest stable release

Overview#

Python Accelerator Middle Layer (pyAML) is a joint technology platform for design, commissioning and operation of particle accelerators. This repository is for the core of pyAML. It is control system independent and is intended to be used together with a package that implements the control system specific interface.

Installation#

Install the package from PyPI:

pip install accelerator-middle-layer

Development#

Install the development dependencies with:

pip install accelerator-middle-layer[dev]

Run the test suite with:

pytest

Install the pre-commit hooks with:

pre-commit install

Documentation#

The documentation is available at:

https://pyaml.readthedocs.io/en/latest/

Contributing#

Please use the issue tracker or submit a pull request.

See also

This package is part of the pyAML ecosystem. See the main pyAML documentation for tutorials, how-to guides, and an overview of the ecosystem.