lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-03-16 23:30:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: xkcd 927 added to documentation of json.gz format.

Browse source
This commit is contained in:
Fabian Joswig 2023-03-13 16:20:25 +00:00
parent 08197efe0f
commit 8530353d32
No known key found for this signature in database
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
pyerrors/__init__.py
View file

@ -409,6 +409,8 @@ For the full API see `pyerrors.linalg`.
# Export data
[![xkcd/927](https://imgs.xkcd.com/comics/standards_2x.png)](https://xkcd.com/927/)
The preferred exported file format within `pyerrors` is json.gz. Files written to this format are valid JSON files that have been compressed using gzip. The structure of the content is inspired by the dobs format of the ALPHA collaboration. The aim of the format is to facilitate the storage of data in a self-contained way such that, even years after the creation of the file, it is possible to extract all necessary information:
- What observables are stored? Possibly: How exactly are they defined.
- How does each single ensemble or external quantity contribute to the error of the observable?