Metadata-Version: 2.4
Name: accelerator-middle-layer
Version: 0.0.0
Summary: Python Accelerator Middle Layer
Project-URL: Homepage, https://github.com/python-accelerator-middle-layer/pyaml
Project-URL: Documentation, https://python-accelerator-middle-layer.github.io/pyaml/
Project-URL: Repository, https://github.com/python-accelerator-middle-layer/pyaml.git
Maintainer-email: Simone Maria Liuzzo <simone.liuzzo@esrf.fr>
License-File: LICENSE
Keywords: Accelerator,Commissioning,Digital Twin,Operation,Synchrotron,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.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.9
Requires-Dist: accelerator-toolbox>=0.6.1
Requires-Dist: numpy>=1.21.0
Requires-Dist: pydantic>=2.11.7
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: scipy>=1.7.3
Provides-Extra: doc
Requires-Dist: sphinx; extra == 'doc'
Requires-Dist: sphinx-rtd-theme; extra == 'doc'
Requires-Dist: travis-sphinx; extra == 'doc'
Provides-Extra: test
Requires-Dist: pytest-cov>=3.0; extra == 'test'
Requires-Dist: pytest>=7.4; extra == 'test'
Description-Content-Type: text/markdown

[![Documentation Status](https://readthedocs.org/projects/pyaml/badge/?version=latest)](https://pyaml.readthedocs.io/en/latest/?badge=latest)

# pyAML: Python Accelerator Middle Layer

Disclaimer: the pyAML software is still under development.

#### Installation

1. Clone the repository
2. Create a virtual environment and activate it
3. Install the package. For editable installation:
   
   ```
   cd pyaml
   pip install -e .
   ```
4. If you want to try the examples using the TANGO bindings you also need [tango-pyaml](https://github.com/python-accelerator-middle-layer/tango-pyaml).
   Clone that repository and install the package inside the same virtual environment as the `pyaml` package.
   tango-pyaml will automatically install pyaml, so step 3 can be skipped.
5. For tests, you may want to install dummy-cs/tango available in
   tests/dummy-cs/tango

#### Documentation

The documentation is hosted on Read the Docs: [pyaml](https://pyaml.readthedocs.io/en/latest/?badge=latest).

#### Examples

Examples are available in the `examples` folder of the repository.
Additionally, in the documentation there are example Jupyter notebooks available.
