mirror of
https://github.com/fjosw/pyerrors.git
synced 2025-07-02 01:39:27 +02:00
Documentation updated
This commit is contained in:
fjosw
parent
ef9a283ba2
commit
9a81ed11a9
3 changed files with 90 additions and 53 deletions
|
|
@ -120,10 +120,10 @@
|
|||
<a class="function" href="#Obs.gamma_method">gamma_method</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="function" href="#Obs.print">print</a>
|
||||
<a class="function" href="#Obs.details">details</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="function" href="#Obs.details">details</a>
|
||||
<a class="function" href="#Obs.print">print</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="function" href="#Obs.is_zero_within_error">is_zero_within_error</a>
|
||||
|
|
@ -647,10 +647,6 @@
|
|||
|
||||
<span class="k">return</span> <span class="n">gamma</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">print</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
|
||||
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">"Method 'print' renamed to 'details'"</span><span class="p">,</span> <span class="ne">DeprecationWarning</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">(</span><span class="n">level</span> <span class="o">></span> <span class="mi">1</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">details</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ens_content</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
|
||||
<span class="sd">"""Output detailed properties of the Obs.</span>
|
||||
|
||||
|
|
@ -684,6 +680,10 @@
|
|||
<span class="n">m</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">len</span><span class="p">,</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">e_content</span><span class="o">.</span><span class="n">keys</span><span class="p">())))</span> <span class="o">+</span> <span class="mi">1</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s1">' '</span> <span class="o">+</span> <span class="n">key</span><span class="o">.</span><span class="n">rjust</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> <span class="o">+</span> <span class="s1">': '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">e_content</span><span class="o">.</span><span class="n">items</span><span class="p">())]))</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">print</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
|
||||
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">"Method 'print' renamed to 'details'"</span><span class="p">,</span> <span class="ne">DeprecationWarning</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">(</span><span class="n">level</span> <span class="o">></span> <span class="mi">1</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">is_zero_within_error</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sigma</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
|
||||
<span class="sd">"""Checks whether the observable is zero within 'sigma' standard errors.</span>
|
||||
|
||||
|
|
@ -2175,10 +2175,6 @@
|
|||
|
||||
<span class="k">return</span> <span class="n">gamma</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">print</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
|
||||
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">"Method 'print' renamed to 'details'"</span><span class="p">,</span> <span class="ne">DeprecationWarning</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">(</span><span class="n">level</span> <span class="o">></span> <span class="mi">1</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">details</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ens_content</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
|
||||
<span class="sd">"""Output detailed properties of the Obs.</span>
|
||||
|
||||
|
|
@ -2212,6 +2208,10 @@
|
|||
<span class="n">m</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">len</span><span class="p">,</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">e_content</span><span class="o">.</span><span class="n">keys</span><span class="p">())))</span> <span class="o">+</span> <span class="mi">1</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s1">' '</span> <span class="o">+</span> <span class="n">key</span><span class="o">.</span><span class="n">rjust</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> <span class="o">+</span> <span class="s1">': '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">e_content</span><span class="o">.</span><span class="n">items</span><span class="p">())]))</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">print</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
|
||||
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">"Method 'print' renamed to 'details'"</span><span class="p">,</span> <span class="ne">DeprecationWarning</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">(</span><span class="n">level</span> <span class="o">></span> <span class="mi">1</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">is_zero_within_error</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sigma</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
|
||||
<span class="sd">"""Checks whether the observable is zero within 'sigma' standard errors.</span>
|
||||
|
||||
|
|
@ -3063,26 +3063,6 @@ of the autocorrelation function (default True)</li>
|
|||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div id="Obs.print" class="classattr">
|
||||
<div class="attr function"><a class="headerlink" href="#Obs.print">#  </a>
|
||||
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">print</span><span class="signature">(self, level=1)</span>:
|
||||
</div>
|
||||
|
||||
<details>
|
||||
<summary>View Source</summary>
|
||||
<div class="codehilite"><pre><span></span> <span class="k">def</span> <span class="nf">print</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
|
||||
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">"Method 'print' renamed to 'details'"</span><span class="p">,</span> <span class="ne">DeprecationWarning</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">(</span><span class="n">level</span> <span class="o">></span> <span class="mi">1</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div id="Obs.details" class="classattr">
|
||||
<div class="attr function"><a class="headerlink" href="#Obs.details">#  </a>
|
||||
|
|
@ -3141,6 +3121,26 @@ print details about the ensembles and replica if true.</li>
|
|||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div id="Obs.print" class="classattr">
|
||||
<div class="attr function"><a class="headerlink" href="#Obs.print">#  </a>
|
||||
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">print</span><span class="signature">(self, level=1)</span>:
|
||||
</div>
|
||||
|
||||
<details>
|
||||
<summary>View Source</summary>
|
||||
<div class="codehilite"><pre><span></span> <span class="k">def</span> <span class="nf">print</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
|
||||
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">"Method 'print' renamed to 'details'"</span><span class="p">,</span> <span class="ne">DeprecationWarning</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">(</span><span class="n">level</span> <span class="o">></span> <span class="mi">1</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div id="Obs.is_zero_within_error" class="classattr">
|
||||
<div class="attr function"><a class="headerlink" href="#Obs.is_zero_within_error">#  </a>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue