PyArchAppl

PyArchAppl is a Python client library for the EPICS Archiver Appliance, providing easy data access, management, and automation for control system data.

---

Features

• Retrieve and plot time-series data from Archiver Appliance
• Management interface for PVs (Process Variables)
• Command-line tools for data access and inspection
• Flexible site configuration
• Support Python 3.9, 3.10, 3.11, 3.12, 3.13

---

Installation

pip install pyarchappl

To upgrade:

pip install --upgrade pyarchappl

---

Quick Start

Data Retrieval Example

from archappl.client import ArchiverDataClient
import matplotlib.pyplot as plt

client = ArchiverDataClient()
client.url = 'http://127.0.0.1:17665'  # Optional, default provided

pv = 'TST:gaussianNoise'
data = client.get_data(pv)

data.plot()
plt.show()

Management Example

from archappl.client import ArchiverMgmtClient

client = ArchiverMgmtClient()
client.url = 'http://127.0.0.1:17665'

all_pvs = client.get_all_pvs(pv="TST*")
print(all_pvs)
# [u'TST:fakeGaussianNoise', u'TST:gaussianNoise', u'TST:uniformNoise']

---

Command Line Tools

PyArchAppl provides convenient CLI tools:

• pyarchappl-get — Retrieve data (use -h for help)
• pyarchappl-inspect — Inspect archiver information (use -h for help)

---

Configuration

PyArchAppl uses an INI-style configuration file to define service connection and behavior.

Config file search order:

1. ~/.pyarchappl/config.ini
2. /etc/pyarchappl/config.ini
3. Package default: main/config/default.ini

Override with the environment variable: PYARCHAPPL_CONFIG_FILE.

See the default.ini for all options.

---

Development

• Clone the repo and install dependencies from requirements.txt and requirements-dev.txt.
• [Optional] Set up a local Archiver Appliance for testing.

---

License

This project is licensed under the GPLv3+ License. See the LICENSE file for details.

---

Links

• Documentation
• Archiver Appliance Docs
• PyPI Project