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
7c25802806
commit
2e9c3e5d9a
2 changed files with 14 additions and 7 deletions
|
@ -77,7 +77,7 @@
|
|||
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">utils</span>
|
||||
|
||||
|
||||
<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">'.*'</span><span class="p">,</span> <span class="n">corr_type</span><span class="o">=</span><span class="s1">'bi'</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">"1.0c"</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<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">'.*'</span><span class="p">,</span> <span class="n">corr_type</span><span class="o">=</span><span class="s1">'bi'</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">"1.0c"</span><span class="p">,</span> <span class="n">cfg_separator</span><span class="o">=</span><span class="s2">"n"</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="sd">"""Read sfcf c format from given folder structure.</span>
|
||||
|
||||
<span class="sd"> Parameters</span>
|
||||
|
@ -111,6 +111,8 @@
|
|||
<span class="sd"> append a "c" to the version (e.g. "1.0c")</span>
|
||||
<span class="sd"> if the append output option (-a) was specified,</span>
|
||||
<span class="sd"> append an "a" to the version</span>
|
||||
<span class="sd"> cfg_separator : str</span>
|
||||
<span class="sd"> String that separates the ensemble identifier from the configuration number (default 'n').</span>
|
||||
<span class="sd"> replica: list</span>
|
||||
<span class="sd"> list of replica to be read, default is all</span>
|
||||
<span class="sd"> files: list</span>
|
||||
|
@ -248,7 +250,7 @@
|
|||
<span class="k">for</span> <span class="n">cfg</span> <span class="ow">in</span> <span class="n">sub_ls</span><span class="p">:</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="n">compact</span><span class="p">:</span>
|
||||
<span class="n">rep_idl</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"n"</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]))</span>
|
||||
<span class="n">rep_idl</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">cfg_separator</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="n">rep_idl</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">cfg</span><span class="p">[</span><span class="mi">3</span><span class="p">:]))</span>
|
||||
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
||||
|
@ -394,7 +396,7 @@
|
|||
<span class="n">stop</span> <span class="o">=</span> <span class="n">start</span> <span class="o">+</span> <span class="n">data_starts</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
|
||||
<span class="n">chunk</span> <span class="o">=</span> <span class="n">content</span><span class="p">[</span><span class="n">start</span><span class="p">:</span><span class="n">stop</span><span class="p">]</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="n">rep_idl</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">chunk</span><span class="p">[</span><span class="n">gauge_line</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"n"</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]))</span>
|
||||
<span class="n">rep_idl</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">chunk</span><span class="p">[</span><span class="n">gauge_line</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">cfg_separator</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]))</span>
|
||||
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"Couldn't parse idl from directory, problem with chunk around line "</span><span class="p">,</span> <span class="n">gauge_line</span><span class="p">)</span>
|
||||
|
||||
|
@ -440,13 +442,14 @@
|
|||
wf=0,
|
||||
wf2=0,
|
||||
version='1.0c',
|
||||
cfg_separator='n',
|
||||
**kwargs
|
||||
)</span>:
|
||||
</div>
|
||||
|
||||
<details>
|
||||
<summary>View Source</summary>
|
||||
<div class="pdoc-code codehilite"><pre><span></span><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">'.*'</span><span class="p">,</span> <span class="n">corr_type</span><span class="o">=</span><span class="s1">'bi'</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">"1.0c"</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<div class="pdoc-code codehilite"><pre><span></span><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">'.*'</span><span class="p">,</span> <span class="n">corr_type</span><span class="o">=</span><span class="s1">'bi'</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">"1.0c"</span><span class="p">,</span> <span class="n">cfg_separator</span><span class="o">=</span><span class="s2">"n"</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="sd">"""Read sfcf c format from given folder structure.</span>
|
||||
|
||||
<span class="sd"> Parameters</span>
|
||||
|
@ -480,6 +483,8 @@
|
|||
<span class="sd"> append a "c" to the version (e.g. "1.0c")</span>
|
||||
<span class="sd"> if the append output option (-a) was specified,</span>
|
||||
<span class="sd"> append an "a" to the version</span>
|
||||
<span class="sd"> cfg_separator : str</span>
|
||||
<span class="sd"> String that separates the ensemble identifier from the configuration number (default 'n').</span>
|
||||
<span class="sd"> replica: list</span>
|
||||
<span class="sd"> list of replica to be read, default is all</span>
|
||||
<span class="sd"> files: list</span>
|
||||
|
@ -617,7 +622,7 @@
|
|||
<span class="k">for</span> <span class="n">cfg</span> <span class="ow">in</span> <span class="n">sub_ls</span><span class="p">:</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="n">compact</span><span class="p">:</span>
|
||||
<span class="n">rep_idl</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"n"</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]))</span>
|
||||
<span class="n">rep_idl</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">cfg_separator</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="n">rep_idl</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">cfg</span><span class="p">[</span><span class="mi">3</span><span class="p">:]))</span>
|
||||
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
||||
|
@ -763,7 +768,7 @@
|
|||
<span class="n">stop</span> <span class="o">=</span> <span class="n">start</span> <span class="o">+</span> <span class="n">data_starts</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
|
||||
<span class="n">chunk</span> <span class="o">=</span> <span class="n">content</span><span class="p">[</span><span class="n">start</span><span class="p">:</span><span class="n">stop</span><span class="p">]</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="n">rep_idl</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">chunk</span><span class="p">[</span><span class="n">gauge_line</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"n"</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]))</span>
|
||||
<span class="n">rep_idl</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">chunk</span><span class="p">[</span><span class="n">gauge_line</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">cfg_separator</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]))</span>
|
||||
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"Couldn't parse idl from directory, problem with chunk around line "</span><span class="p">,</span> <span class="n">gauge_line</span><span class="p">)</span>
|
||||
|
||||
|
@ -827,6 +832,8 @@ if the compact output option (-c) was specified,
|
|||
append a "c" to the version (e.g. "1.0c")
|
||||
if the append output option (-a) was specified,
|
||||
append an "a" to the version</li>
|
||||
<li><strong>cfg_separator</strong> (str):
|
||||
String that separates the ensemble identifier from the configuration number (default 'n').</li>
|
||||
<li><strong>replica</strong> (list):
|
||||
list of replica to be read, default is all</li>
|
||||
<li><strong>files</strong> (list):
|
||||
|
|
File diff suppressed because one or more lines are too long
Loading…
Add table
Reference in a new issue