From 0e685d552a8c98082fe22df87f59ca71bf119121 Mon Sep 17 00:00:00 2001 From: Simon Kuberski Date: Mon, 21 Feb 2022 18:46:56 +0100 Subject: [PATCH] Added reference to JSON schema --- pyerrors/__init__.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pyerrors/__init__.py b/pyerrors/__init__.py index 4e2db252..0aeb65d8 100644 --- a/pyerrors/__init__.py +++ b/pyerrors/__init__.py @@ -381,6 +381,8 @@ The array `cdata` contains information about the contribution of auxiliary obser - `cov`, an array that contains the $M\times M$ many entries of the covariance matrix, stored in row-major format. - `grad`, an array that contains N entries, one for each `Obs` inside the structure. Each entry itself is an array, that contains the M gradients of the Nth observable with respect to the quantity that corresponds to the Mth diagonal entry of the covariance matrix. +A JSON schema that may be used to verify the correctness of a file with respect to the format definition is stored in ./examples/json_schema.json. The schema is a self-descriptive format definition and contains an exemplary file. + ## Jackknife samples For comparison with other analysis workflows `pyerrors` can generate jackknife samples from an `Obs` object or import jackknife samples into an `Obs` object. See `pyerrors.obs.Obs.export_jackknife` and `pyerrors.obs.import_jackknife` for details.