lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-03-15 14:50:25 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: explanation of json.gz example slightly extended.

Browse source
This commit is contained in:
Fabian Joswig 2022-02-22 10:15:11 +00:00
parent 350ccc083e
commit e435907a07
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
pyerrors/__init__.py
View file

@ -384,13 +384,14 @@ 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")
my_obs.dump("test_output_file", description="This file contains a test observable")
check = pe.input.json.load_json("test_output_file")
print(my_obs == check)
> True
```
The format also allows to directly write out the content of `Corr` objects or lists and arrays of `Obs` objects by passing the desired data to `pyerrors.input.json.dump_to_json`.
## json.gz format specification
The first entries of the file provide optional auxiliary information: