Documentation updated

This commit is contained in:
fjosw 2022-02-21 18:07:44 +00:00
parent 0a89411184
commit ad9243f344
2 changed files with 13 additions and 9 deletions

View file

@ -461,7 +461,7 @@ Make sure to check the autocorrelation time with e.g. <code><a href="pyerrors/ob
<p>The only necessary entry of the file is the field
-<code>obsdata</code>, an array that contains the actual data.</p>
<p>Each entry of the array belongs to a single structure of observables. Currently, these strucutres can be eiter of <code>Obs</code>, <code>list</code>, <code>numpy.ndarray</code>, <code>Corr</code>. All <code>Obs</code> inside a structure (with dimension &gt; 0) have to be defined on the same set of configurations. Different structures, that are represented by entries of the array <code>obsdata</code>, are treated independently. Each entry of the array <code>obsdata</code> has the following required entries:</p>
<p>Each entry of the array belongs to a single structure of observables. Currently, these structures can be either of <code>Obs</code>, <code>list</code>, <code>numpy.ndarray</code>, <code>Corr</code>. All <code>Obs</code> inside a structure (with dimension &gt; 0) have to be defined on the same set of configurations. Different structures, that are represented by entries of the array <code>obsdata</code>, are treated independently. Each entry of the array <code>obsdata</code> has the following required entries:</p>
<ul>
<li><code>type</code> is a string that specifies the type of the structure. This allows to parse the content to the correct form after reading the file. It is always possible to interpret the content as list of Obs.</li>
@ -498,6 +498,8 @@ The following entries are optional:</li>
<p>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.</p>
<p>Julia I/O routines for the json.gz format, compatible with <a href="https://gitlab.ift.uam-csic.es/alberto/aderrors.jl">ADerrors.jl</a>, can be found <a href="https://github.com/fjosw/ADjson.jl">here</a>.</p>
<h2 id="jackknife-samples">Jackknife samples</h2>
<p>For comparison with other analysis workflows <code><a href="">pyerrors</a></code> can generate jackknife samples from an <code>Obs</code> object or import jackknife samples into an <code>Obs</code> object.
@ -873,7 +875,7 @@ See <code><a href="pyerrors/obs.html#Obs.export_jackknife">pyerrors.obs.Obs.expo
<span class="sd">The only necessary entry of the file is the field</span>
<span class="sd">-`obsdata`, an array that contains the actual data.</span>
<span class="sd">Each entry of the array belongs to a single structure of observables. Currently, these strucutres can be eiter of `Obs`, `list`, `numpy.ndarray`, `Corr`. All `Obs` inside a structure (with dimension &gt; 0) have to be defined on the same set of configurations. Different structures, that are represented by entries of the array `obsdata`, are treated independently. Each entry of the array `obsdata` has the following required entries:</span>
<span class="sd">Each entry of the array belongs to a single structure of observables. Currently, these structures can be either of `Obs`, `list`, `numpy.ndarray`, `Corr`. All `Obs` inside a structure (with dimension &gt; 0) have to be defined on the same set of configurations. Different structures, that are represented by entries of the array `obsdata`, are treated independently. Each entry of the array `obsdata` has the following required entries:</span>
<span class="sd">- `type` is a string that specifies the type of the structure. This allows to parse the content to the correct form after reading the file. It is always possible to interpret the content as list of Obs.</span>
<span class="sd">- `value` is an array that contains the mean values of the Obs inside the structure.</span>
<span class="sd">The following entries are optional:</span>
@ -901,6 +903,8 @@ See <code><a href="pyerrors/obs.html#Obs.export_jackknife">pyerrors.obs.Obs.expo
<span class="sd">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.</span>
<span class="sd">Julia I/O routines for the json.gz format, compatible with [ADerrors.jl](https://gitlab.ift.uam-csic.es/alberto/aderrors.jl), can be found [here](https://github.com/fjosw/ADjson.jl).</span>
<span class="sd">## Jackknife samples</span>
<span class="sd">For comparison with other analysis workflows `pyerrors` can generate jackknife samples from an `Obs` object or import jackknife samples into an `Obs` object.</span>
<span class="sd">See `pyerrors.obs.Obs.export_jackknife` and `pyerrors.obs.import_jackknife` for details.</span>

File diff suppressed because one or more lines are too long