Documentation updated

This commit is contained in:
fjosw 2023-01-03 10:01:33 +00:00
parent 849c12a78e
commit d85fbddcdf
18 changed files with 324 additions and 324 deletions

View file

@ -85,7 +85,7 @@
</span><span id="L-7"><a href="#L-7"><span class="linenos"> 7</span></a>
</span><span id="L-8"><a href="#L-8"><span class="linenos"> 8</span></a>
</span><span id="L-9"><a href="#L-9"><span class="linenos"> 9</span></a><span class="k">def</span> <span class="nf">read_sfcf</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">prefix</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">quarks</span><span class="o">=</span><span class="s1">&#39;.*&#39;</span><span class="p">,</span> <span class="n">corr_type</span><span class="o">=</span><span class="s1">&#39;bi&#39;</span><span class="p">,</span> <span class="n">noffset</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">wf</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">wf2</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="s2">&quot;1.0c&quot;</span><span class="p">,</span> <span class="n">cfg_separator</span><span class="o">=</span><span class="s2">&quot;n&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
</span><span id="L-10"><a href="#L-10"><span class="linenos"> 10</span></a> <span class="sd">&quot;&quot;&quot;Read sfcf c format from given folder structure.</span>
</span><span id="L-10"><a href="#L-10"><span class="linenos"> 10</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Read sfcf c format from given folder structure.</span>
</span><span id="L-11"><a href="#L-11"><span class="linenos"> 11</span></a>
</span><span id="L-12"><a href="#L-12"><span class="linenos"> 12</span></a><span class="sd"> Parameters</span>
</span><span id="L-13"><a href="#L-13"><span class="linenos"> 13</span></a><span class="sd"> ----------</span>
@ -457,7 +457,7 @@
</div>
<a class="headerlink" href="#read_sfcf"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="read_sfcf-10"><a href="#read_sfcf-10"><span class="linenos"> 10</span></a><span class="k">def</span> <span class="nf">read_sfcf</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">prefix</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">quarks</span><span class="o">=</span><span class="s1">&#39;.*&#39;</span><span class="p">,</span> <span class="n">corr_type</span><span class="o">=</span><span class="s1">&#39;bi&#39;</span><span class="p">,</span> <span class="n">noffset</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">wf</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">wf2</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="s2">&quot;1.0c&quot;</span><span class="p">,</span> <span class="n">cfg_separator</span><span class="o">=</span><span class="s2">&quot;n&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
</span><span id="read_sfcf-11"><a href="#read_sfcf-11"><span class="linenos"> 11</span></a> <span class="sd">&quot;&quot;&quot;Read sfcf c format from given folder structure.</span>
</span><span id="read_sfcf-11"><a href="#read_sfcf-11"><span class="linenos"> 11</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Read sfcf c format from given folder structure.</span>
</span><span id="read_sfcf-12"><a href="#read_sfcf-12"><span class="linenos"> 12</span></a>
</span><span id="read_sfcf-13"><a href="#read_sfcf-13"><span class="linenos"> 13</span></a><span class="sd"> Parameters</span>
</span><span id="read_sfcf-14"><a href="#read_sfcf-14"><span class="linenos"> 14</span></a><span class="sd"> ----------</span>