mirror of
https://github.com/fjosw/pyerrors.git
synced 2025-03-16 15:20:24 +01:00
Documentation updated
This commit is contained in:
parent
7e3aa29de9
commit
cd108ef9c1
2 changed files with 61 additions and 34 deletions
|
@ -226,10 +226,13 @@
|
|||
<span class="sd">"""Read hadrons ExternalLeg hdf5 file and output an array of CObs</span>
|
||||
|
||||
<span class="sd"> Parameters</span>
|
||||
<span class="sd"> -----------------</span>
|
||||
<span class="sd"> path -- path to the files to read</span>
|
||||
<span class="sd"> filestem -- namestem of the files to read</span>
|
||||
<span class="sd"> ens_id -- name of the ensemble, required for internal bookkeeping</span>
|
||||
<span class="sd"> ----------</span>
|
||||
<span class="sd"> path : str</span>
|
||||
<span class="sd"> path to the files to read</span>
|
||||
<span class="sd"> filestem : str</span>
|
||||
<span class="sd"> namestem of the files to read</span>
|
||||
<span class="sd"> ens_id : str</span>
|
||||
<span class="sd"> name of the ensemble, required for internal bookkeeping</span>
|
||||
<span class="sd"> idl : range</span>
|
||||
<span class="sd"> If specified only configurations in the given range are read in.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
@ -263,10 +266,13 @@
|
|||
<span class="sd">"""Read hadrons Bilinear hdf5 file and output an array of CObs</span>
|
||||
|
||||
<span class="sd"> Parameters</span>
|
||||
<span class="sd"> -----------------</span>
|
||||
<span class="sd"> path -- path to the files to read</span>
|
||||
<span class="sd"> filestem -- namestem of the files to read</span>
|
||||
<span class="sd"> ens_id -- name of the ensemble, required for internal bookkeeping</span>
|
||||
<span class="sd"> ----------</span>
|
||||
<span class="sd"> path : str</span>
|
||||
<span class="sd"> path to the files to read</span>
|
||||
<span class="sd"> filestem : str</span>
|
||||
<span class="sd"> namestem of the files to read</span>
|
||||
<span class="sd"> ens_id : str</span>
|
||||
<span class="sd"> name of the ensemble, required for internal bookkeeping</span>
|
||||
<span class="sd"> idl : range</span>
|
||||
<span class="sd"> If specified only configurations in the given range are read in.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
@ -314,10 +320,13 @@
|
|||
<span class="sd">"""Read hadrons FourquarkFullyConnected hdf5 file and output an array of CObs</span>
|
||||
|
||||
<span class="sd"> Parameters</span>
|
||||
<span class="sd"> -----------------</span>
|
||||
<span class="sd"> path -- path to the files to read</span>
|
||||
<span class="sd"> filestem -- namestem of the files to read</span>
|
||||
<span class="sd"> ens_id -- name of the ensemble, required for internal bookkeeping</span>
|
||||
<span class="sd"> ----------</span>
|
||||
<span class="sd"> path : str</span>
|
||||
<span class="sd"> path to the files to read</span>
|
||||
<span class="sd"> filestem : str</span>
|
||||
<span class="sd"> namestem of the files to read</span>
|
||||
<span class="sd"> ens_id : str</span>
|
||||
<span class="sd"> name of the ensemble, required for internal bookkeeping</span>
|
||||
<span class="sd"> idl : range</span>
|
||||
<span class="sd"> If specified only configurations in the given range are read in.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
@ -752,10 +761,13 @@ in and out momenta of the propagator are exchanged.</p>
|
|||
<span class="sd">"""Read hadrons ExternalLeg hdf5 file and output an array of CObs</span>
|
||||
|
||||
<span class="sd"> Parameters</span>
|
||||
<span class="sd"> -----------------</span>
|
||||
<span class="sd"> path -- path to the files to read</span>
|
||||
<span class="sd"> filestem -- namestem of the files to read</span>
|
||||
<span class="sd"> ens_id -- name of the ensemble, required for internal bookkeeping</span>
|
||||
<span class="sd"> ----------</span>
|
||||
<span class="sd"> path : str</span>
|
||||
<span class="sd"> path to the files to read</span>
|
||||
<span class="sd"> filestem : str</span>
|
||||
<span class="sd"> namestem of the files to read</span>
|
||||
<span class="sd"> ens_id : str</span>
|
||||
<span class="sd"> name of the ensemble, required for internal bookkeeping</span>
|
||||
<span class="sd"> idl : range</span>
|
||||
<span class="sd"> If specified only configurations in the given range are read in.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
@ -792,9 +804,12 @@ in and out momenta of the propagator are exchanged.</p>
|
|||
<h6 id="parameters">Parameters</h6>
|
||||
|
||||
<ul>
|
||||
<li><strong>path -- path to the files to read</strong></li>
|
||||
<li><strong>filestem -- namestem of the files to read</strong></li>
|
||||
<li><strong>ens_id -- name of the ensemble, required for internal bookkeeping</strong></li>
|
||||
<li><strong>path</strong> (str):
|
||||
path to the files to read</li>
|
||||
<li><strong>filestem</strong> (str):
|
||||
namestem of the files to read</li>
|
||||
<li><strong>ens_id</strong> (str):
|
||||
name of the ensemble, required for internal bookkeeping</li>
|
||||
<li><strong>idl</strong> (range):
|
||||
If specified only configurations in the given range are read in.</li>
|
||||
</ul>
|
||||
|
@ -816,10 +831,13 @@ If specified only configurations in the given range are read in.</li>
|
|||
<span class="sd">"""Read hadrons Bilinear hdf5 file and output an array of CObs</span>
|
||||
|
||||
<span class="sd"> Parameters</span>
|
||||
<span class="sd"> -----------------</span>
|
||||
<span class="sd"> path -- path to the files to read</span>
|
||||
<span class="sd"> filestem -- namestem of the files to read</span>
|
||||
<span class="sd"> ens_id -- name of the ensemble, required for internal bookkeeping</span>
|
||||
<span class="sd"> ----------</span>
|
||||
<span class="sd"> path : str</span>
|
||||
<span class="sd"> path to the files to read</span>
|
||||
<span class="sd"> filestem : str</span>
|
||||
<span class="sd"> namestem of the files to read</span>
|
||||
<span class="sd"> ens_id : str</span>
|
||||
<span class="sd"> name of the ensemble, required for internal bookkeeping</span>
|
||||
<span class="sd"> idl : range</span>
|
||||
<span class="sd"> If specified only configurations in the given range are read in.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
@ -870,9 +888,12 @@ If specified only configurations in the given range are read in.</li>
|
|||
<h6 id="parameters">Parameters</h6>
|
||||
|
||||
<ul>
|
||||
<li><strong>path -- path to the files to read</strong></li>
|
||||
<li><strong>filestem -- namestem of the files to read</strong></li>
|
||||
<li><strong>ens_id -- name of the ensemble, required for internal bookkeeping</strong></li>
|
||||
<li><strong>path</strong> (str):
|
||||
path to the files to read</li>
|
||||
<li><strong>filestem</strong> (str):
|
||||
namestem of the files to read</li>
|
||||
<li><strong>ens_id</strong> (str):
|
||||
name of the ensemble, required for internal bookkeeping</li>
|
||||
<li><strong>idl</strong> (range):
|
||||
If specified only configurations in the given range are read in.</li>
|
||||
</ul>
|
||||
|
@ -894,10 +915,13 @@ If specified only configurations in the given range are read in.</li>
|
|||
<span class="sd">"""Read hadrons FourquarkFullyConnected hdf5 file and output an array of CObs</span>
|
||||
|
||||
<span class="sd"> Parameters</span>
|
||||
<span class="sd"> -----------------</span>
|
||||
<span class="sd"> path -- path to the files to read</span>
|
||||
<span class="sd"> filestem -- namestem of the files to read</span>
|
||||
<span class="sd"> ens_id -- name of the ensemble, required for internal bookkeeping</span>
|
||||
<span class="sd"> ----------</span>
|
||||
<span class="sd"> path : str</span>
|
||||
<span class="sd"> path to the files to read</span>
|
||||
<span class="sd"> filestem : str</span>
|
||||
<span class="sd"> namestem of the files to read</span>
|
||||
<span class="sd"> ens_id : str</span>
|
||||
<span class="sd"> name of the ensemble, required for internal bookkeeping</span>
|
||||
<span class="sd"> idl : range</span>
|
||||
<span class="sd"> If specified only configurations in the given range are read in.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
@ -953,9 +977,12 @@ If specified only configurations in the given range are read in.</li>
|
|||
<h6 id="parameters">Parameters</h6>
|
||||
|
||||
<ul>
|
||||
<li><strong>path -- path to the files to read</strong></li>
|
||||
<li><strong>filestem -- namestem of the files to read</strong></li>
|
||||
<li><strong>ens_id -- name of the ensemble, required for internal bookkeeping</strong></li>
|
||||
<li><strong>path</strong> (str):
|
||||
path to the files to read</li>
|
||||
<li><strong>filestem</strong> (str):
|
||||
namestem of the files to read</li>
|
||||
<li><strong>ens_id</strong> (str):
|
||||
name of the ensemble, required for internal bookkeeping</li>
|
||||
<li><strong>idl</strong> (range):
|
||||
If specified only configurations in the given range are read in.</li>
|
||||
</ul>
|
||||
|
|
File diff suppressed because one or more lines are too long
Loading…
Add table
Reference in a new issue