lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-05-14 19:43:41 +02:00
Code Issues Projects Releases Packages Wiki Activity

Documentation updated

Browse source
This commit is contained in:
fjosw 2023-03-13 16:26:58 +00:00
parent a6983b2c6e
commit ea074d4f55
2 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/pyerrors.html
View file

@ -576,7 +576,7 @@ Details about how the required covariance matrix is estimated can be found in <c
<h1 id="export-data">Export data</h1>
<p><a href="https://xkcd.com/927/"><img src="https://imgs.xkcd.com/comics/standards_2x.png" alt="xkcd/927" /></a></p>
<p><a href="https://xkcd.com/927/"><img src="https://imgs.xkcd.com/comics/standards_2x.png" width="30%" height="30%"></a></p>
<p>The preferred exported file format within <code><a href="">pyerrors</a></code> 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:</p>
@ -1076,7 +1076,7 @@ The following entries are optional:</li>
</span><span id="L-409"><a href="#L-409"><span class="linenos">409</span></a>
</span><span id="L-410"><a href="#L-410"><span class="linenos">410</span></a><span class="sd"># Export data</span>
</span><span id="L-411"><a href="#L-411"><span class="linenos">411</span></a>
</span><span id="L-412"><a href="#L-412"><span class="linenos">412</span></a><span class="sd">[![xkcd/927](https://imgs.xkcd.com/comics/standards_2x.png)](https://xkcd.com/927/)</span>
</span><span id="L-412"><a href="#L-412"><span class="linenos">412</span></a><span class="sd">[&lt;img src=&quot;https://imgs.xkcd.com/comics/standards_2x.png&quot; width=&quot;30%&quot; height=&quot;30%&quot;&gt;](https://xkcd.com/927/)</span>
</span><span id="L-413"><a href="#L-413"><span class="linenos">413</span></a>
</span><span id="L-414"><a href="#L-414"><span class="linenos">414</span></a><span class="sd">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:</span>
</span><span id="L-415"><a href="#L-415"><span class="linenos">415</span></a><span class="sd">- What observables are stored? Possibly: How exactly are they defined.</span>