From 313c0f5e41cfbb4a1cd10314fd0c5e53ca86e732 Mon Sep 17 00:00:00 2001 From: fjosw Date: Tue, 22 Feb 2022 10:11:24 +0000 Subject: [PATCH] Documentation updated --- docs/pyerrors.html | 42 +++++++++++++++++++++++++++++++++++++++--- docs/search.js | 2 +- 2 files changed, 40 insertions(+), 4 deletions(-) diff --git a/docs/pyerrors.html b/docs/pyerrors.html index 539855d3..f6d15626 100644 --- a/docs/pyerrors.html +++ b/docs/pyerrors.html @@ -60,7 +60,10 @@
  • Total least squares fits
  • Matrix operations
    • -
  • Export data
    • +
  • Export data +
  • Citing
    • @@ -480,7 +483,24 @@ where the Jacobian is computed for each derived quantity via automatic different
  • Who did write the file when and on which machine?
    • -

    This can be achieved by storing all information in one single file. The export routines of pyerrors are written such that as much information as possible is written automatically. The first entries of the file provide optional auxiliary information:

    +

    This can be achieved by storing all information in one single file. The export routines of pyerrors are written such that as much information as possible is written automatically as described in the following example

    + +
    my_obs = pe.Obs([samples], ["test_ensemble"])
+my_obs.tag = "My observable"
+
+pe.input.json.dump_to_json(my_obs, "test_output_file", description="This file contains a test observable")
+# For a single observable one can equivalently use the class method dump
+my_obs.dump("test_output", description="This file contains a test observable")
+
+check = pe.input.json.load_json("test_output_file")
+
+print(my_obs == check)
+> True
+
    + +

    json.gz format specification

    + +

    The first entries of the file provide optional auxiliary information: