PyArchAppl

Python 3.9+

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()

Example Plot

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:

~/.pyarchappl/config.ini
/etc/pyarchappl/config.ini
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.

Release files for pyarchappl 1.0.3.post1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for pyarchappl 1.0.3.post1
File	Interpreter	ABI	Platform	Reset
pyarchappl-1.0.3.post1-py3-none-any.whl 49.8 kB Sep 19, 2025	Python 3	none	any	Details

Release files / pyarchappl-1.0.3.post1-py3-none-any.whl

Download URL	pyarchappl-1.0.3.post1-py3-none-any.whl
Size	49.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`28003744d4284451cd78e01890cafd81b192c97b2d6faa20ad7d46165e2e48ea`
BLAKE2b-256 checksum How to use checksums	`52f67f67480d3a340cba25919acc551cdfdc61de82a446ef414a2f788afbd3c1`
Upload date	Sep 19, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.8.20`