summaryrefslogtreecommitdiff
path: root/python-apstrim.spec
blob: 8abebb9622dd05ab1cc597683097aa38faba0eac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
%global _empty_manifest_terminate_build 0
Name:		python-apstrim
Version:	2.0.6
Release:	1
Summary:	Parameter and Object Serializer for EPICS, ADO or LITE
License:	MIT
URL:		https://github.com/ASukhanov/apstrim
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/64/d2/ea828c9ed1b57b081eab81c76bb85da1af5e26bfd64da951d6a1762f88cd/apstrim-2.0.6.tar.gz
BuildArch:	noarch

Requires:	python3-caproto
Requires:	python3-msgpack

%description
# apstrim
Logger and extractor of time-series data (e.g. EPICS PVs).

- Data are objects, indexed in time order.
- Supported Control Infrastructures: EPICS, ADO, LITE. Easy extendable.
- Wide range of data objects: strings, lists, maps, numpy arrays, custom.
- Data objects could be inhomogeneous and have arbitrary frequency.
- Self-describing data format, no schema required.
- Data objects are binary-serialized using MessagePack.
- Fast online compression.
- Fast random-access retrieval of data objects for selected time interval.
- Simultaneous writing and reading.
- Typical speed of compressed serialization to a logbook file is 80 MB/s.
- De-serialization speed is up to 1200 MB/s when the logbook is cached in memory.
- Basic plotting of the logged data.

<img src='/docs/apstrim_file_format.png' width='400'>

## Installation
Dependencies: **msgpack, caproto, lz4framed**. 
These packages will be installed using pip:

    pip3 install apstrim

The example program for deserialization and plotting **apstrim.view**,
requires additional package: **pyqtgraph**.

## API refrerence

[apstrim](https://htmlpreview.github.io/?https://github.com/ASukhanov/apstrim/blob/main/docs/apstrim.html)

[scan](https://htmlpreview.github.io/?https://github.com/ASukhanov/apstrim/blob/main/docs/scan.html)

## Examples

## Serialization

	# Serialization of one float64 parameter from an EPICS simulated scope IOC:
	:python -m apstrim -nEPICS -T59 testAPD:scope1:MeanValue_RBV
	Logging finished for 1 sections, 1 parLists, 7.263 KB.
	...

    # The same with compression:
	:python -m apstrim -nEPICS -T59 testAPD:scope1:MeanValue_RBV --compress
    Logging finished for 1 sections, 1 parLists, 6.101 KB. Compression ratio:1.19
	...

    # Serialization 1000-element array and one scalar of floats:
    :python -m apstrim -nEPICS -T59 testAPD:scope1:MeanValue_RBV,Waveform_RBV --compress
    Logging finished for 1 sections, 2 parLists, 2405.354 KB. Compression ratio:1.0
	...
	# Note, Compression is poor for floating point arrays with high entropy.

	# Serialization of an incrementing integer parameter:
	:python -m apstrim -nLITE --compress liteHost:dev1:cycle
    Logging finished for 1 sections, 1 parLists, 56.526 KB. Compression ratio:1.25
	...
	# In this case the normalized compressed volume is 9.3 bytes per entry.
	# Each entry consist of an int64 timestamp and an int64 value, which would 
	# occupy 16 bytes per entry using standard writing.

### De-serialization
Example of deserialization and plotting of all parameters from several logbooks.

    python -m apstrim.view -i all -p *.aps

Python code snippet to extract items 1,2 and 3 from a logbook
for 20 seconds interval starting on 2021-08-12 at 23:31:31.

```python
from apstrim.scan import APScan
apscan = APScan('aLogbook.aps')
headers = apscan.get_headers()
print(f'{headers["Index"]}')
extracted = apscan.extract_objects(span=20, items=[1,2,3], startTime='210812_233131')
print(f'{extracted[3]}')# print the extracted data for item[3]
# returned:
{'par': 'liteBridge.peakSimulator:rps',           # object (PV) name of the item[3]
'times': [1628825500.8938403, 1628825510.898658], # list of the item[3] timestamps
'values': [95.675125, 95.55396]}                  # list of the item[3] values
```





%package -n python3-apstrim
Summary:	Parameter and Object Serializer for EPICS, ADO or LITE
Provides:	python-apstrim
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-apstrim
# apstrim
Logger and extractor of time-series data (e.g. EPICS PVs).

- Data are objects, indexed in time order.
- Supported Control Infrastructures: EPICS, ADO, LITE. Easy extendable.
- Wide range of data objects: strings, lists, maps, numpy arrays, custom.
- Data objects could be inhomogeneous and have arbitrary frequency.
- Self-describing data format, no schema required.
- Data objects are binary-serialized using MessagePack.
- Fast online compression.
- Fast random-access retrieval of data objects for selected time interval.
- Simultaneous writing and reading.
- Typical speed of compressed serialization to a logbook file is 80 MB/s.
- De-serialization speed is up to 1200 MB/s when the logbook is cached in memory.
- Basic plotting of the logged data.

<img src='/docs/apstrim_file_format.png' width='400'>

## Installation
Dependencies: **msgpack, caproto, lz4framed**. 
These packages will be installed using pip:

    pip3 install apstrim

The example program for deserialization and plotting **apstrim.view**,
requires additional package: **pyqtgraph**.

## API refrerence

[apstrim](https://htmlpreview.github.io/?https://github.com/ASukhanov/apstrim/blob/main/docs/apstrim.html)

[scan](https://htmlpreview.github.io/?https://github.com/ASukhanov/apstrim/blob/main/docs/scan.html)

## Examples

## Serialization

	# Serialization of one float64 parameter from an EPICS simulated scope IOC:
	:python -m apstrim -nEPICS -T59 testAPD:scope1:MeanValue_RBV
	Logging finished for 1 sections, 1 parLists, 7.263 KB.
	...

    # The same with compression:
	:python -m apstrim -nEPICS -T59 testAPD:scope1:MeanValue_RBV --compress
    Logging finished for 1 sections, 1 parLists, 6.101 KB. Compression ratio:1.19
	...

    # Serialization 1000-element array and one scalar of floats:
    :python -m apstrim -nEPICS -T59 testAPD:scope1:MeanValue_RBV,Waveform_RBV --compress
    Logging finished for 1 sections, 2 parLists, 2405.354 KB. Compression ratio:1.0
	...
	# Note, Compression is poor for floating point arrays with high entropy.

	# Serialization of an incrementing integer parameter:
	:python -m apstrim -nLITE --compress liteHost:dev1:cycle
    Logging finished for 1 sections, 1 parLists, 56.526 KB. Compression ratio:1.25
	...
	# In this case the normalized compressed volume is 9.3 bytes per entry.
	# Each entry consist of an int64 timestamp and an int64 value, which would 
	# occupy 16 bytes per entry using standard writing.

### De-serialization
Example of deserialization and plotting of all parameters from several logbooks.

    python -m apstrim.view -i all -p *.aps

Python code snippet to extract items 1,2 and 3 from a logbook
for 20 seconds interval starting on 2021-08-12 at 23:31:31.

```python
from apstrim.scan import APScan
apscan = APScan('aLogbook.aps')
headers = apscan.get_headers()
print(f'{headers["Index"]}')
extracted = apscan.extract_objects(span=20, items=[1,2,3], startTime='210812_233131')
print(f'{extracted[3]}')# print the extracted data for item[3]
# returned:
{'par': 'liteBridge.peakSimulator:rps',           # object (PV) name of the item[3]
'times': [1628825500.8938403, 1628825510.898658], # list of the item[3] timestamps
'values': [95.675125, 95.55396]}                  # list of the item[3] values
```





%package help
Summary:	Development documents and examples for apstrim
Provides:	python3-apstrim-doc
%description help
# apstrim
Logger and extractor of time-series data (e.g. EPICS PVs).

- Data are objects, indexed in time order.
- Supported Control Infrastructures: EPICS, ADO, LITE. Easy extendable.
- Wide range of data objects: strings, lists, maps, numpy arrays, custom.
- Data objects could be inhomogeneous and have arbitrary frequency.
- Self-describing data format, no schema required.
- Data objects are binary-serialized using MessagePack.
- Fast online compression.
- Fast random-access retrieval of data objects for selected time interval.
- Simultaneous writing and reading.
- Typical speed of compressed serialization to a logbook file is 80 MB/s.
- De-serialization speed is up to 1200 MB/s when the logbook is cached in memory.
- Basic plotting of the logged data.

<img src='/docs/apstrim_file_format.png' width='400'>

## Installation
Dependencies: **msgpack, caproto, lz4framed**. 
These packages will be installed using pip:

    pip3 install apstrim

The example program for deserialization and plotting **apstrim.view**,
requires additional package: **pyqtgraph**.

## API refrerence

[apstrim](https://htmlpreview.github.io/?https://github.com/ASukhanov/apstrim/blob/main/docs/apstrim.html)

[scan](https://htmlpreview.github.io/?https://github.com/ASukhanov/apstrim/blob/main/docs/scan.html)

## Examples

## Serialization

	# Serialization of one float64 parameter from an EPICS simulated scope IOC:
	:python -m apstrim -nEPICS -T59 testAPD:scope1:MeanValue_RBV
	Logging finished for 1 sections, 1 parLists, 7.263 KB.
	...

    # The same with compression:
	:python -m apstrim -nEPICS -T59 testAPD:scope1:MeanValue_RBV --compress
    Logging finished for 1 sections, 1 parLists, 6.101 KB. Compression ratio:1.19
	...

    # Serialization 1000-element array and one scalar of floats:
    :python -m apstrim -nEPICS -T59 testAPD:scope1:MeanValue_RBV,Waveform_RBV --compress
    Logging finished for 1 sections, 2 parLists, 2405.354 KB. Compression ratio:1.0
	...
	# Note, Compression is poor for floating point arrays with high entropy.

	# Serialization of an incrementing integer parameter:
	:python -m apstrim -nLITE --compress liteHost:dev1:cycle
    Logging finished for 1 sections, 1 parLists, 56.526 KB. Compression ratio:1.25
	...
	# In this case the normalized compressed volume is 9.3 bytes per entry.
	# Each entry consist of an int64 timestamp and an int64 value, which would 
	# occupy 16 bytes per entry using standard writing.

### De-serialization
Example of deserialization and plotting of all parameters from several logbooks.

    python -m apstrim.view -i all -p *.aps

Python code snippet to extract items 1,2 and 3 from a logbook
for 20 seconds interval starting on 2021-08-12 at 23:31:31.

```python
from apstrim.scan import APScan
apscan = APScan('aLogbook.aps')
headers = apscan.get_headers()
print(f'{headers["Index"]}')
extracted = apscan.extract_objects(span=20, items=[1,2,3], startTime='210812_233131')
print(f'{extracted[3]}')# print the extracted data for item[3]
# returned:
{'par': 'liteBridge.peakSimulator:rps',           # object (PV) name of the item[3]
'times': [1628825500.8938403, 1628825510.898658], # list of the item[3] timestamps
'values': [95.675125, 95.55396]}                  # list of the item[3] values
```





%prep
%autosetup -n apstrim-2.0.6

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-apstrim -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Wed May 31 2023 Python_Bot <Python_Bot@openeuler.org> - 2.0.6-1
- Package Spec generated