From 8530353d324963cdfca20684d1bd39d673fdb17a Mon Sep 17 00:00:00 2001 From: Fabian Joswig Date: Mon, 13 Mar 2023 16:20:25 +0000 Subject: [PATCH] docs: xkcd 927 added to documentation of json.gz format. --- pyerrors/__init__.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pyerrors/__init__.py b/pyerrors/__init__.py index aad89ab2..37bfb3e9 100644 --- a/pyerrors/__init__.py +++ b/pyerrors/__init__.py @@ -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?