Clear definition of a quantify dataset
Description
- Add a formal specificatio of the dataset to the documentation.
- Add a validator to verify if a dataset is a valid dataset.
- suggestion use the JSON based validation pattern that is also used for validating Gettables, Settables and TUIDs.
Motivation
The quantify dataset is currently defined as the dataset that is output by the measurement control. There is a very clear format for these datasets.
- it is an
xarray
dataset - that must have the following properties - name : a string - tuid : a TUID
- all Settables correspond to coordinates with keys
"x{i}"
. These arexarray.DataArray
- all Gettables correspond to data variables with keys
"y{i}"
. These arexarray.DataArray
- all Gettables and Settables must have the attributes - long_name - name - units
However, this format is not specified anywhere in the documentation, and also does not contain a validator. I am encountering this issue in !156 (merged) , where I want a custom dataset to be accepted as an input argument for the analysis, and in !111 (closed) , where a conversion from QCoDeS to a quantify dataset is made. Additionally, this also relates to #139 .
I am of the opinion that the dataset should also allow for additional coordinates, data variables and attributes to account for use-cases we do not yet anticipate.
Edited by Victor Negîrneac