Documentation updated

This commit is contained in:
fjosw 2022-01-21 14:55:18 +00:00
parent 773f85cf7f
commit 556340a6cc
3 changed files with 58 additions and 32 deletions

View file

@ -69,10 +69,7 @@
<details>
<summary>View Source</summary>
<div class="codehilite"><pre><span></span><span class="ch">#!/usr/bin/env python</span>
<span class="c1"># coding: utf-8</span>
<span class="kn">import</span> <span class="nn">os</span>
<div class="codehilite"><pre><span></span><span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">fnmatch</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">struct</span>
@ -83,11 +80,12 @@
<span class="k">def</span> <span class="nf">read_pbp</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="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Read pbp format from given folder structure. Returns a list of length nrw</span>
<span class="sd"> Keyword arguments</span>
<span class="sd"> -----------------</span>
<span class="sd"> r_start -- list which contains the first config to be read for each replicum</span>
<span class="sd"> r_stop -- list which contains the last config to be read for each replicum</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> r_start : list</span>
<span class="sd"> list which contains the first config to be read for each replicum</span>
<span class="sd"> r_stop : list</span>
<span class="sd"> list which contains the last config to be read for each replicum</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">extract_nfct</span> <span class="o">=</span> <span class="mi">1</span>
@ -137,7 +135,6 @@
<span class="n">tmp_array</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">path</span> <span class="o">+</span> <span class="s1">&#39;/&#39;</span> <span class="o">+</span> <span class="n">ls</span><span class="p">[</span><span class="n">rep</span><span class="p">],</span> <span class="s1">&#39;rb&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">fp</span><span class="p">:</span>
<span class="c1"># header</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span> <span class="c1"># number of reweighting factors</span>
<span class="k">if</span> <span class="n">rep</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">nrw</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">&#39;i&#39;</span><span class="p">,</span> <span class="n">t</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
@ -145,7 +142,7 @@
<span class="n">deltas</span><span class="o">.</span><span class="n">append</span><span class="p">([])</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">nrw</span> <span class="o">!=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">&#39;i&#39;</span><span class="p">,</span> <span class="n">t</span><span class="p">)[</span><span class="mi">0</span><span class="p">]:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;Error: different number of reweighting factors for replicum&#39;</span><span class="p">,</span> <span class="n">rep</span><span class="p">)</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;Error: different number of factors for replicum&#39;</span><span class="p">,</span> <span class="n">rep</span><span class="p">)</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">nrw</span><span class="p">):</span>
<span class="n">tmp_array</span><span class="o">.</span><span class="n">append</span><span class="p">([])</span>
@ -218,11 +215,12 @@
<div class="codehilite"><pre><span></span><span class="k">def</span> <span class="nf">read_pbp</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="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Read pbp format from given folder structure. Returns a list of length nrw</span>
<span class="sd"> Keyword arguments</span>
<span class="sd"> -----------------</span>
<span class="sd"> r_start -- list which contains the first config to be read for each replicum</span>
<span class="sd"> r_stop -- list which contains the last config to be read for each replicum</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> r_start : list</span>
<span class="sd"> list which contains the first config to be read for each replicum</span>
<span class="sd"> r_stop : list</span>
<span class="sd"> list which contains the last config to be read for each replicum</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">extract_nfct</span> <span class="o">=</span> <span class="mi">1</span>
@ -272,7 +270,6 @@
<span class="n">tmp_array</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">path</span> <span class="o">+</span> <span class="s1">&#39;/&#39;</span> <span class="o">+</span> <span class="n">ls</span><span class="p">[</span><span class="n">rep</span><span class="p">],</span> <span class="s1">&#39;rb&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">fp</span><span class="p">:</span>
<span class="c1"># header</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span> <span class="c1"># number of reweighting factors</span>
<span class="k">if</span> <span class="n">rep</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">nrw</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">&#39;i&#39;</span><span class="p">,</span> <span class="n">t</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
@ -280,7 +277,7 @@
<span class="n">deltas</span><span class="o">.</span><span class="n">append</span><span class="p">([])</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">nrw</span> <span class="o">!=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">&#39;i&#39;</span><span class="p">,</span> <span class="n">t</span><span class="p">)[</span><span class="mi">0</span><span class="p">]:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;Error: different number of reweighting factors for replicum&#39;</span><span class="p">,</span> <span class="n">rep</span><span class="p">)</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;Error: different number of factors for replicum&#39;</span><span class="p">,</span> <span class="n">rep</span><span class="p">)</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">nrw</span><span class="p">):</span>
<span class="n">tmp_array</span><span class="o">.</span><span class="n">append</span><span class="p">([])</span>
@ -341,10 +338,14 @@
<div class="docstring"><p>Read pbp format from given folder structure. Returns a list of length nrw</p>
<h6 id="keyword-arguments">Keyword arguments</h6>
<h6 id="parameters">Parameters</h6>
<p>r_start -- list which contains the first config to be read for each replicum
r_stop -- list which contains the last config to be read for each replicum</p>
<ul>
<li><strong>r_start</strong> (list):
list which contains the first config to be read for each replicum</li>
<li><strong>r_stop</strong> (list):
list which contains the last config to be read for each replicum</li>
</ul>
</div>