jaseg/sampling-mesh-monitor
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README: Describe data format better

Browse source
This commit is contained in:
jaseg 2025-10-27 14:08:07 +01:00
parent 3a7a8cff27
commit 9f6fb67452
1 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.rst
View file

@ -55,7 +55,12 @@ Repo structure
``analysis``
All raw data, as well as the Jupyter notebooks used for analysis and plotting. By running these notebooks, you can
re-run the analysis, and re-export all plots in the paper.
re-run the analysis, and re-export all plots in the paper. The raw data is contained in JSON files, one per
measurement series. Each JSON file contains some metadata describing the experiment and the settings used during the
experiment, a set of calibration runs with the target specimen disconnected using the board's routing switches, and
a full set of 12 measurement arrays consisting of a mean and standard deviation for each data point. To save space,
batches of these JSON files are aggregated into zip archives. The analysis Jupyter notebooks will automatically load
and decode the data from these zip archives when run.
``paper``
The source of the paper, as well as exports of all plots.