Skip to content

Commit a276150

Browse files
committed
(fixup) Clarify file format versions
1 parent 324b428 commit a276150

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

docs/data_format.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -195,11 +195,15 @@ Format versions
195195
**Warning:** This flips the meaning compared to earlier versions with ``0`` indicating a *safe* train and a positive number for unreliable timing.
196196
* ``METADATA/dataSources`` contains a static virtual source ``Karabo_TimeServer`` with an empty entry in ``METADATA/dataSources/root``.
197197

198+
The EuXFEL DAQ software used this format version only briefly around July 2021.
199+
198200
1.0
199201
~~~
200202

201203
* ``INDEX`` group contains only the top-level datasets ``trainId``, ``timestamp``, ``flag``.
202204

205+
The EuXFEL DAQ software used this format version between February 2020 and July 2021.
206+
203207
0.5
204208
~~~
205209

@@ -209,21 +213,22 @@ Format versions
209213
* ``METADATA`` group is identical to ``METADATA/dataSources`` in later versions,
210214
i.e. directly contains the datasets ``root``, ``deviceId`` and ``dataSourceId``.
211215

216+
The EuXFEL DAQ software used this format version between February 2018 and April 2020.
217+
212218
0.1
213219
~~~
214220

215221
**Warning:** This file format version is lacking the ``METADATA/dataFormatVersion`` dataset and can thus only be inferred from its structure.
216222

217-
**Warning:** This file format version is **not** supported by EXtra-data.
218-
219223
Same as 0.5 in addition to:
220224

221225
* ``INDEX/{deviceId}`` group specifies the mapping from trains to data rows of each source via ``first``/``last`` datasets with ``last = first + count - 1`` denoting the last row index belonging to a particular train.
222226

227+
The EuXFEL DAQ software used this format version until April 2018.
228+
223229

224230
References
225231
----------
226232

227-
228233
.. [1] Decking et al: *A MHz-repetition-rate hard X-ray free-electron laser driven by a superconducting linear accelerator*, Nature Photonics 391-397, 2020
229234
.. [2] European XFEL DAQ and Control systems naming convention: https://docs.xfel.eu/share/s/dDHQtDIkRUiXPr9DM6WQ-Q

0 commit comments

Comments
 (0)