mirror of
https://github.com/fjosw/pyerrors.git
synced 2025-05-14 19:43:41 +02:00
Documentation updated
This commit is contained in:
fjosw
parent
0cfc2d3b02
commit
e88e210823
22 changed files with 282 additions and 198 deletions
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -1153,7 +1153,11 @@ The following entries are optional:</li>
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.correlators API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -1042,7 +1042,7 @@
|
|||
</span><span id="L-825"><a href="#L-825"><span class="linenos"> 825</span></a> <span class="n">hide_from</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">argmax</span><span class="p">((</span><span class="n">hide_sigma</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">y_err</span><span class="p">[</span><span class="mi">1</span><span class="p">:]))</span> <span class="o">></span> <span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">y</span><span class="p">[</span><span class="mi">1</span><span class="p">:]))</span> <span class="o">-</span> <span class="mi">1</span>
|
||||
</span><span id="L-826"><a href="#L-826"><span class="linenos"> 826</span></a> <span class="k">else</span><span class="p">:</span>
|
||||
</span><span id="L-827"><a href="#L-827"><span class="linenos"> 827</span></a> <span class="n">hide_from</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
</span><span id="L-828"><a href="#L-828"><span class="linenos"> 828</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">errorbar</span><span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">y</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">y_err</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">label</span><span class="o">=</span><span class="n">corr</span><span class="o">.</span><span class="n">tag</span><span class="p">,</span> <span class="n">mfc</span><span class="o">=</span><span class="n">plt</span><span class="o">.</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'axes.facecolor'</span><span class="p">])</span>
|
||||
</span><span id="L-828"><a href="#L-828"><span class="linenos"> 828</span></a> <span class="n">ax1</span><span class="o">.</span><span class="n">errorbar</span><span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">y</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">y_err</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">label</span><span class="o">=</span><span class="n">corr</span><span class="o">.</span><span class="n">tag</span><span class="p">,</span> <span class="n">mfc</span><span class="o">=</span><span class="n">plt</span><span class="o">.</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'axes.facecolor'</span><span class="p">])</span>
|
||||
</span><span id="L-829"><a href="#L-829"><span class="linenos"> 829</span></a> <span class="k">else</span><span class="p">:</span>
|
||||
</span><span id="L-830"><a href="#L-830"><span class="linenos"> 830</span></a> <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"'comp' must be a correlator or a list of correlators."</span><span class="p">)</span>
|
||||
</span><span id="L-831"><a href="#L-831"><span class="linenos"> 831</span></a>
|
||||
|
|
@ -2328,7 +2328,7 @@
|
|||
</span><span id="Corr-826"><a href="#Corr-826"><span class="linenos"> 826</span></a> <span class="n">hide_from</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">argmax</span><span class="p">((</span><span class="n">hide_sigma</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">y_err</span><span class="p">[</span><span class="mi">1</span><span class="p">:]))</span> <span class="o">></span> <span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">y</span><span class="p">[</span><span class="mi">1</span><span class="p">:]))</span> <span class="o">-</span> <span class="mi">1</span>
|
||||
</span><span id="Corr-827"><a href="#Corr-827"><span class="linenos"> 827</span></a> <span class="k">else</span><span class="p">:</span>
|
||||
</span><span id="Corr-828"><a href="#Corr-828"><span class="linenos"> 828</span></a> <span class="n">hide_from</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
</span><span id="Corr-829"><a href="#Corr-829"><span class="linenos"> 829</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">errorbar</span><span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">y</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">y_err</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">label</span><span class="o">=</span><span class="n">corr</span><span class="o">.</span><span class="n">tag</span><span class="p">,</span> <span class="n">mfc</span><span class="o">=</span><span class="n">plt</span><span class="o">.</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'axes.facecolor'</span><span class="p">])</span>
|
||||
</span><span id="Corr-829"><a href="#Corr-829"><span class="linenos"> 829</span></a> <span class="n">ax1</span><span class="o">.</span><span class="n">errorbar</span><span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">y</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">y_err</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">label</span><span class="o">=</span><span class="n">corr</span><span class="o">.</span><span class="n">tag</span><span class="p">,</span> <span class="n">mfc</span><span class="o">=</span><span class="n">plt</span><span class="o">.</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'axes.facecolor'</span><span class="p">])</span>
|
||||
</span><span id="Corr-830"><a href="#Corr-830"><span class="linenos"> 830</span></a> <span class="k">else</span><span class="p">:</span>
|
||||
</span><span id="Corr-831"><a href="#Corr-831"><span class="linenos"> 831</span></a> <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"'comp' must be a correlator or a list of correlators."</span><span class="p">)</span>
|
||||
</span><span id="Corr-832"><a href="#Corr-832"><span class="linenos"> 832</span></a>
|
||||
|
|
@ -2879,7 +2879,7 @@ region indentified for this correlator.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">gamma_method</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">gamma_method</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.gamma_method-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -2908,7 +2908,7 @@ region indentified for this correlator.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">projected</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">vector_l</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">vector_r</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">normalize</span><span class="o">=</span><span class="kc">False</span></span>)</span>
|
||||
<span class="name">projected</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">vector_l</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">vector_r</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">normalize</span><span class="o">=</span><span class="kc">False</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.projected-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -2969,7 +2969,7 @@ By default it will return the lowest source, which usually means unsmeared-unsme
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">item</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">i</span>, </span><span class="param"><span class="n">j</span></span>)</span>
|
||||
<span class="name">item</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">i</span>, </span><span class="param"><span class="n">j</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.item-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3011,7 +3011,7 @@ Second index to be picked.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">plottable</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">plottable</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.plottable-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3046,7 +3046,7 @@ timeslice and the error on each timeslice.</p>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">symmetric</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">symmetric</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.symmetric-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3084,7 +3084,7 @@ timeslice and the error on each timeslice.</p>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">anti_symmetric</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">anti_symmetric</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.anti_symmetric-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3124,7 +3124,7 @@ timeslice and the error on each timeslice.</p>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">is_matrix_symmetric</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">is_matrix_symmetric</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.is_matrix_symmetric-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3157,7 +3157,7 @@ timeslice and the error on each timeslice.</p>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">matrix_symmetric</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">matrix_symmetric</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.matrix_symmetric-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3185,7 +3185,7 @@ timeslice and the error on each timeslice.</p>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">GEVP</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">t0</span>, </span><span class="param"><span class="n">ts</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">sort</span><span class="o">=</span><span class="s1">'Eigenvalue'</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">GEVP</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">t0</span>, </span><span class="param"><span class="n">ts</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">sort</span><span class="o">=</span><span class="s1">'Eigenvalue'</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.GEVP-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3320,7 +3320,7 @@ Returns only the vector(s) for a specified state. The lowest state is zero.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">Eigenvalue</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">t0</span>, </span><span class="param"><span class="n">ts</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">state</span><span class="o">=</span><span class="mi">0</span>, </span><span class="param"><span class="n">sort</span><span class="o">=</span><span class="s1">'Eigenvalue'</span></span>)</span>
|
||||
<span class="name">Eigenvalue</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">t0</span>, </span><span class="param"><span class="n">ts</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">state</span><span class="o">=</span><span class="mi">0</span>, </span><span class="param"><span class="n">sort</span><span class="o">=</span><span class="s1">'Eigenvalue'</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.Eigenvalue-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3359,7 +3359,7 @@ The state one is interested in ordered by energy. The lowest state is zero.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">Hankel</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">N</span>, </span><span class="param"><span class="n">periodic</span><span class="o">=</span><span class="kc">False</span></span>)</span>
|
||||
<span class="name">Hankel</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">N</span>, </span><span class="param"><span class="n">periodic</span><span class="o">=</span><span class="kc">False</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.Hankel-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3432,7 +3432,7 @@ determines whether the matrix is extended periodically</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">roll</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">dt</span></span>)</span>
|
||||
<span class="name">roll</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">dt</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.roll-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3467,7 +3467,7 @@ number of timeslices</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">reverse</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">reverse</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.reverse-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3489,7 +3489,7 @@ number of timeslices</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">thin</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">spacing</span><span class="o">=</span><span class="mi">2</span>, </span><span class="param"><span class="n">offset</span><span class="o">=</span><span class="mi">0</span></span>)</span>
|
||||
<span class="name">thin</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">spacing</span><span class="o">=</span><span class="mi">2</span>, </span><span class="param"><span class="n">offset</span><span class="o">=</span><span class="mi">0</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.thin-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3534,7 +3534,7 @@ Offset the equal spacing</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">correlate</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">partner</span></span>)</span>
|
||||
<span class="name">correlate</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">partner</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.correlate-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3590,7 +3590,7 @@ correlator or a Corr of same length.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">reweight</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">weight</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">reweight</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">weight</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.reweight-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3643,7 +3643,7 @@ on the configurations in obs[i].idl.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">T_symmetry</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">partner</span>, </span><span class="param"><span class="n">parity</span><span class="o">=</span><span class="mi">1</span></span>)</span>
|
||||
<span class="name">T_symmetry</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">partner</span>, </span><span class="param"><span class="n">parity</span><span class="o">=</span><span class="mi">1</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.T_symmetry-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3700,7 +3700,7 @@ Parity quantum number of the correlator, can be +1 or -1</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">deriv</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">variant</span><span class="o">=</span><span class="s1">'symmetric'</span></span>)</span>
|
||||
<span class="name">deriv</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">variant</span><span class="o">=</span><span class="s1">'symmetric'</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.deriv-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3780,7 +3780,7 @@ Available choice: symmetric, forward, backward, improved, default: symmetric</li
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">second_deriv</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">variant</span><span class="o">=</span><span class="s1">'symmetric'</span></span>)</span>
|
||||
<span class="name">second_deriv</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">variant</span><span class="o">=</span><span class="s1">'symmetric'</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.second_deriv-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3840,7 +3840,7 @@ Available choice: symmetric, improved, default: symmetric</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">m_eff</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">variant</span><span class="o">=</span><span class="s1">'log'</span>, </span><span class="param"><span class="n">guess</span><span class="o">=</span><span class="mf">1.0</span></span>)</span>
|
||||
<span class="name">m_eff</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">variant</span><span class="o">=</span><span class="s1">'log'</span>, </span><span class="param"><span class="n">guess</span><span class="o">=</span><span class="mf">1.0</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.m_eff-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3940,7 +3940,7 @@ guess for the root finder, only relevant for the root variant</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">fit</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">function</span>, </span><span class="param"><span class="n">fitrange</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">silent</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">fit</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">function</span>, </span><span class="param"><span class="n">fitrange</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">silent</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.fit-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4006,7 +4006,7 @@ Decides whether output is printed to the standard output.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">plateau</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">plateau_range</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">method</span><span class="o">=</span><span class="s1">'fit'</span>, </span><span class="param"><span class="n">auto_gamma</span><span class="o">=</span><span class="kc">False</span></span>)</span>
|
||||
<span class="name">plateau</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">plateau_range</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">method</span><span class="o">=</span><span class="s1">'fit'</span>, </span><span class="param"><span class="n">auto_gamma</span><span class="o">=</span><span class="kc">False</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.plateau-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4075,7 +4075,7 @@ apply gamma_method with default parameters to the Corr. Defaults to None</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">set_prange</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">prange</span></span>)</span>
|
||||
<span class="name">set_prange</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">prange</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.set_prange-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4105,7 +4105,7 @@ apply gamma_method with default parameters to the Corr. Defaults to None</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">show</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">x_range</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">comp</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">y_range</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">logscale</span><span class="o">=</span><span class="kc">False</span>,</span><span class="param"> <span class="n">plateau</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">fit_res</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">ylabel</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">save</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">auto_gamma</span><span class="o">=</span><span class="kc">False</span>,</span><span class="param"> <span class="n">hide_sigma</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">references</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">title</span><span class="o">=</span><span class="kc">None</span></span>)</span>
|
||||
<span class="name">show</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">x_range</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">comp</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">y_range</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">logscale</span><span class="o">=</span><span class="kc">False</span>,</span><span class="param"> <span class="n">plateau</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">fit_res</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">ylabel</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">save</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">auto_gamma</span><span class="o">=</span><span class="kc">False</span>,</span><span class="param"> <span class="n">hide_sigma</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">references</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">title</span><span class="o">=</span><span class="kc">None</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.show-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4180,7 +4180,7 @@ apply gamma_method with default parameters to the Corr. Defaults to None</li>
|
|||
</span><span id="Corr.show-826"><a href="#Corr.show-826"><span class="linenos">826</span></a> <span class="n">hide_from</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">argmax</span><span class="p">((</span><span class="n">hide_sigma</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">y_err</span><span class="p">[</span><span class="mi">1</span><span class="p">:]))</span> <span class="o">></span> <span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">y</span><span class="p">[</span><span class="mi">1</span><span class="p">:]))</span> <span class="o">-</span> <span class="mi">1</span>
|
||||
</span><span id="Corr.show-827"><a href="#Corr.show-827"><span class="linenos">827</span></a> <span class="k">else</span><span class="p">:</span>
|
||||
</span><span id="Corr.show-828"><a href="#Corr.show-828"><span class="linenos">828</span></a> <span class="n">hide_from</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
</span><span id="Corr.show-829"><a href="#Corr.show-829"><span class="linenos">829</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">errorbar</span><span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">y</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">y_err</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">label</span><span class="o">=</span><span class="n">corr</span><span class="o">.</span><span class="n">tag</span><span class="p">,</span> <span class="n">mfc</span><span class="o">=</span><span class="n">plt</span><span class="o">.</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'axes.facecolor'</span><span class="p">])</span>
|
||||
</span><span id="Corr.show-829"><a href="#Corr.show-829"><span class="linenos">829</span></a> <span class="n">ax1</span><span class="o">.</span><span class="n">errorbar</span><span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">y</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">y_err</span><span class="p">[:</span><span class="n">hide_from</span><span class="p">],</span> <span class="n">label</span><span class="o">=</span><span class="n">corr</span><span class="o">.</span><span class="n">tag</span><span class="p">,</span> <span class="n">mfc</span><span class="o">=</span><span class="n">plt</span><span class="o">.</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'axes.facecolor'</span><span class="p">])</span>
|
||||
</span><span id="Corr.show-830"><a href="#Corr.show-830"><span class="linenos">830</span></a> <span class="k">else</span><span class="p">:</span>
|
||||
</span><span id="Corr.show-831"><a href="#Corr.show-831"><span class="linenos">831</span></a> <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"'comp' must be a correlator or a list of correlators."</span><span class="p">)</span>
|
||||
</span><span id="Corr.show-832"><a href="#Corr.show-832"><span class="linenos">832</span></a>
|
||||
|
|
@ -4270,7 +4270,7 @@ Optional title of the figure.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">spaghetti_plot</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">logscale</span><span class="o">=</span><span class="kc">True</span></span>)</span>
|
||||
<span class="name">spaghetti_plot</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">logscale</span><span class="o">=</span><span class="kc">True</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.spaghetti_plot-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4324,7 +4324,7 @@ Determines whether the scale of the y-axis is logarithmic or standard.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">dump</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">filename</span>, </span><span class="param"><span class="n">datatype</span><span class="o">=</span><span class="s1">'json.gz'</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">dump</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">filename</span>, </span><span class="param"><span class="n">datatype</span><span class="o">=</span><span class="s1">'json.gz'</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.dump-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4378,7 +4378,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">print</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">print_range</span><span class="o">=</span><span class="kc">None</span></span>)</span>
|
||||
<span class="name">print</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">print_range</span><span class="o">=</span><span class="kc">None</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.print-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4397,7 +4397,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">sqrt</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">sqrt</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.sqrt-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4416,7 +4416,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">log</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">log</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.log-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4436,7 +4436,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">exp</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">exp</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.exp-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4456,7 +4456,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">sin</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">sin</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.sin-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4475,7 +4475,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">cos</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">cos</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.cos-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4494,7 +4494,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">tan</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">tan</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.tan-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4513,7 +4513,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">sinh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">sinh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.sinh-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4532,7 +4532,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">cosh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">cosh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.cosh-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4551,7 +4551,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">tanh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">tanh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.tanh-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4570,7 +4570,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">arcsin</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">arcsin</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.arcsin-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4589,7 +4589,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">arccos</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">arccos</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.arccos-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4608,7 +4608,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">arctan</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">arctan</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.arctan-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4627,7 +4627,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">arcsinh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">arcsinh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.arcsinh-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4646,7 +4646,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">arccosh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">arccosh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.arccosh-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4665,7 +4665,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">arctanh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">arctanh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.arctanh-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4706,7 +4706,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">prune</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">Ntrunc</span>, </span><span class="param"><span class="n">tproj</span><span class="o">=</span><span class="mi">3</span>, </span><span class="param"><span class="n">t0proj</span><span class="o">=</span><span class="mi">2</span>, </span><span class="param"><span class="n">basematrix</span><span class="o">=</span><span class="kc">None</span></span>)</span>
|
||||
<span class="name">prune</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">Ntrunc</span>, </span><span class="param"><span class="n">tproj</span><span class="o">=</span><span class="mi">3</span>, </span><span class="param"><span class="n">t0proj</span><span class="o">=</span><span class="mi">2</span>, </span><span class="param"><span class="n">basematrix</span><span class="o">=</span><span class="kc">None</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Corr.prune-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4913,7 +4913,11 @@ bound $t_0 \leq t/2$ holds, since the condition number of $G(t)$ is decreased, c
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.covobs API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -385,7 +385,7 @@ Gradient of the Covobs wrt. the means belonging to cov.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">errsq</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">errsq</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Covobs.errsq-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -529,7 +529,11 @@ Gradient of the Covobs wrt. the means belonging to cov.</li>
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.dirac API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -171,7 +171,7 @@
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">epsilon_tensor</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">i</span>, </span><span class="param"><span class="n">j</span>, </span><span class="param"><span class="n">k</span></span>)</span>
|
||||
<span class="name">epsilon_tensor</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">i</span>, </span><span class="param"><span class="n">j</span>, </span><span class="param"><span class="n">k</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="epsilon_tensor-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -202,7 +202,7 @@
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">epsilon_tensor_rank4</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">i</span>, </span><span class="param"><span class="n">j</span>, </span><span class="param"><span class="n">k</span>, </span><span class="param"><span class="n">o</span></span>)</span>
|
||||
<span class="name">epsilon_tensor_rank4</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">i</span>, </span><span class="param"><span class="n">j</span>, </span><span class="param"><span class="n">k</span>, </span><span class="param"><span class="n">o</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="epsilon_tensor_rank4-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -233,7 +233,7 @@
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">Grid_gamma</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">gamma_tag</span></span>)</span>
|
||||
<span class="name">Grid_gamma</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">gamma_tag</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Grid_gamma-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -387,7 +387,11 @@
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.fits API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -951,7 +951,7 @@ also accessible via indices.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">gamma_method</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">gamma_method</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Fit_result.gamma_method-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -984,7 +984,7 @@ also accessible via indices.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">least_squares</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span>, </span><span class="param"><span class="n">y</span>, </span><span class="param"><span class="n">func</span>, </span><span class="param"><span class="n">priors</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">silent</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">least_squares</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span>, </span><span class="param"><span class="n">y</span>, </span><span class="param"><span class="n">func</span>, </span><span class="param"><span class="n">priors</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">silent</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="least_squares-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1120,7 +1120,7 @@ If True, a quantile-quantile plot of the fit result is generated (default False)
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">total_least_squares</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span>, </span><span class="param"><span class="n">y</span>, </span><span class="param"><span class="n">func</span>, </span><span class="param"><span class="n">silent</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">total_least_squares</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span>, </span><span class="param"><span class="n">y</span>, </span><span class="param"><span class="n">func</span>, </span><span class="param"><span class="n">silent</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="total_least_squares-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1368,7 +1368,7 @@ has to be calculated (default False).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">fit_lin</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span>, </span><span class="param"><span class="n">y</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">fit_lin</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span>, </span><span class="param"><span class="n">y</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="fit_lin-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1421,7 +1421,7 @@ List of Obs, the dvalues of the Obs are used as yerror for the fit.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">qqplot</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span>, </span><span class="param"><span class="n">o_y</span>, </span><span class="param"><span class="n">func</span>, </span><span class="param"><span class="n">p</span></span>)</span>
|
||||
<span class="name">qqplot</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span>, </span><span class="param"><span class="n">o_y</span>, </span><span class="param"><span class="n">func</span>, </span><span class="param"><span class="n">p</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="qqplot-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1465,7 +1465,7 @@ check if the residuals of the fit are gaussian distributed.</p>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">residual_plot</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span>, </span><span class="param"><span class="n">y</span>, </span><span class="param"><span class="n">func</span>, </span><span class="param"><span class="n">fit_res</span></span>)</span>
|
||||
<span class="name">residual_plot</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span>, </span><span class="param"><span class="n">y</span>, </span><span class="param"><span class="n">func</span>, </span><span class="param"><span class="n">fit_res</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="residual_plot-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1512,7 +1512,7 @@ check if the residuals of the fit are gaussian distributed.</p>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">error_band</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span>, </span><span class="param"><span class="n">func</span>, </span><span class="param"><span class="n">beta</span></span>)</span>
|
||||
<span class="name">error_band</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span>, </span><span class="param"><span class="n">func</span>, </span><span class="param"><span class="n">beta</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="error_band-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1547,7 +1547,7 @@ check if the residuals of the fit are gaussian distributed.</p>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">ks_test</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">objects</span><span class="o">=</span><span class="kc">None</span></span>)</span>
|
||||
<span class="name">ks_test</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">objects</span><span class="o">=</span><span class="kc">None</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="ks_test-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1709,7 +1709,11 @@ List of fit results to include in the analysis (optional).</li>
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.input API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -209,7 +209,11 @@ See <code><a href="obs.html#Obs.export_jackknife">pyerrors.obs.Obs.export_jackkn
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.input.bdio API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -768,7 +768,7 @@
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_ADerrors</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">file_path</span>, </span><span class="param"><span class="n">bdio_path</span><span class="o">=</span><span class="s1">'./libbdio.so'</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">read_ADerrors</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">file_path</span>, </span><span class="param"><span class="n">bdio_path</span><span class="o">=</span><span class="s1">'./libbdio.so'</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_ADerrors-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -950,7 +950,7 @@ adding the flag -fPIC to CC and changing the all target to</p>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">write_ADerrors</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obs_list</span>, </span><span class="param"><span class="n">file_path</span>, </span><span class="param"><span class="n">bdio_path</span><span class="o">=</span><span class="s1">'./libbdio.so'</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">write_ADerrors</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obs_list</span>, </span><span class="param"><span class="n">file_path</span>, </span><span class="param"><span class="n">bdio_path</span><span class="o">=</span><span class="s1">'./libbdio.so'</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="write_ADerrors-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1106,7 +1106,7 @@ adding the flag -fPIC to CC and changing the all target to</p>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_mesons</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">file_path</span>, </span><span class="param"><span class="n">bdio_path</span><span class="o">=</span><span class="s1">'./libbdio.so'</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">read_mesons</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">file_path</span>, </span><span class="param"><span class="n">bdio_path</span><span class="o">=</span><span class="s1">'./libbdio.so'</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_mesons-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1359,7 +1359,7 @@ Manually overwrite ensemble name</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_dSdm</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">file_path</span>, </span><span class="param"><span class="n">bdio_path</span><span class="o">=</span><span class="s1">'./libbdio.so'</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">read_dSdm</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">file_path</span>, </span><span class="param"><span class="n">bdio_path</span><span class="o">=</span><span class="s1">'./libbdio.so'</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_dSdm-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1681,7 +1681,11 @@ Manually overwrite ensemble name</li>
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.input.dobs API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -976,7 +976,7 @@
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">create_pobs_string</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obsl</span>, </span><span class="param"><span class="n">name</span>, </span><span class="param"><span class="n">spec</span><span class="o">=</span><span class="s1">''</span>, </span><span class="param"><span class="n">origin</span><span class="o">=</span><span class="s1">''</span>, </span><span class="param"><span class="n">symbol</span><span class="o">=</span><span class="p">[]</span>, </span><span class="param"><span class="n">enstag</span><span class="o">=</span><span class="kc">None</span></span>)</span>
|
||||
<span class="name">create_pobs_string</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obsl</span>, </span><span class="param"><span class="n">name</span>, </span><span class="param"><span class="n">spec</span><span class="o">=</span><span class="s1">''</span>, </span><span class="param"><span class="n">origin</span><span class="o">=</span><span class="s1">''</span>, </span><span class="param"><span class="n">symbol</span><span class="o">=</span><span class="p">[]</span>, </span><span class="param"><span class="n">enstag</span><span class="o">=</span><span class="kc">None</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="create_pobs_string-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1100,7 +1100,7 @@ Enstag that is written to pobs. If None, the ensemble name is used.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">write_pobs</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">obsl</span>,</span><span class="param"> <span class="n">fname</span>,</span><span class="param"> <span class="n">name</span>,</span><span class="param"> <span class="n">spec</span><span class="o">=</span><span class="s1">''</span>,</span><span class="param"> <span class="n">origin</span><span class="o">=</span><span class="s1">''</span>,</span><span class="param"> <span class="n">symbol</span><span class="o">=</span><span class="p">[]</span>,</span><span class="param"> <span class="n">enstag</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">gz</span><span class="o">=</span><span class="kc">True</span></span>)</span>
|
||||
<span class="name">write_pobs</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">obsl</span>,</span><span class="param"> <span class="n">fname</span>,</span><span class="param"> <span class="n">name</span>,</span><span class="param"> <span class="n">spec</span><span class="o">=</span><span class="s1">''</span>,</span><span class="param"> <span class="n">origin</span><span class="o">=</span><span class="s1">''</span>,</span><span class="param"> <span class="n">symbol</span><span class="o">=</span><span class="p">[]</span>,</span><span class="param"> <span class="n">enstag</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">gz</span><span class="o">=</span><span class="kc">True</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="write_pobs-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1185,7 +1185,7 @@ If True, the output is a gzipped xml. If False, the output is an xml file.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_pobs</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">fname</span>, </span><span class="param"><span class="n">full_output</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="n">gz</span><span class="o">=</span><span class="kc">True</span>, </span><span class="param"><span class="n">separator_insertion</span><span class="o">=</span><span class="kc">None</span></span>)</span>
|
||||
<span class="name">read_pobs</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">fname</span>, </span><span class="param"><span class="n">full_output</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="n">gz</span><span class="o">=</span><span class="kc">True</span>, </span><span class="param"><span class="n">separator_insertion</span><span class="o">=</span><span class="kc">None</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_pobs-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1310,7 +1310,7 @@ None (default): Replica names remain unchanged.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">import_dobs_string</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">content</span>, </span><span class="param"><span class="n">noempty</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="n">full_output</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="n">separator_insertion</span><span class="o">=</span><span class="kc">True</span></span>)</span>
|
||||
<span class="name">import_dobs_string</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">content</span>, </span><span class="param"><span class="n">noempty</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="n">full_output</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="n">separator_insertion</span><span class="o">=</span><span class="kc">True</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="import_dobs_string-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1512,7 +1512,7 @@ None or False: No separator is inserted.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_dobs</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">fname</span>,</span><span class="param"> <span class="n">noempty</span><span class="o">=</span><span class="kc">False</span>,</span><span class="param"> <span class="n">full_output</span><span class="o">=</span><span class="kc">False</span>,</span><span class="param"> <span class="n">gz</span><span class="o">=</span><span class="kc">True</span>,</span><span class="param"> <span class="n">separator_insertion</span><span class="o">=</span><span class="kc">True</span></span>)</span>
|
||||
<span class="name">read_dobs</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">fname</span>,</span><span class="param"> <span class="n">noempty</span><span class="o">=</span><span class="kc">False</span>,</span><span class="param"> <span class="n">full_output</span><span class="o">=</span><span class="kc">False</span>,</span><span class="param"> <span class="n">gz</span><span class="o">=</span><span class="kc">True</span>,</span><span class="param"> <span class="n">separator_insertion</span><span class="o">=</span><span class="kc">True</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_dobs-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1595,7 +1595,7 @@ None or False: No separator is inserted.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">create_dobs_string</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">obsl</span>,</span><span class="param"> <span class="n">name</span>,</span><span class="param"> <span class="n">spec</span><span class="o">=</span><span class="s1">'dobs v1.0'</span>,</span><span class="param"> <span class="n">origin</span><span class="o">=</span><span class="s1">''</span>,</span><span class="param"> <span class="n">symbol</span><span class="o">=</span><span class="p">[]</span>,</span><span class="param"> <span class="n">who</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">enstags</span><span class="o">=</span><span class="kc">None</span></span>)</span>
|
||||
<span class="name">create_dobs_string</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">obsl</span>,</span><span class="param"> <span class="n">name</span>,</span><span class="param"> <span class="n">spec</span><span class="o">=</span><span class="s1">'dobs v1.0'</span>,</span><span class="param"> <span class="n">origin</span><span class="o">=</span><span class="s1">''</span>,</span><span class="param"> <span class="n">symbol</span><span class="o">=</span><span class="p">[]</span>,</span><span class="param"> <span class="n">who</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">enstags</span><span class="o">=</span><span class="kc">None</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="create_dobs_string-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1821,7 +1821,7 @@ Otherwise, the ensemble name is used.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">write_dobs</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">obsl</span>,</span><span class="param"> <span class="n">fname</span>,</span><span class="param"> <span class="n">name</span>,</span><span class="param"> <span class="n">spec</span><span class="o">=</span><span class="s1">'dobs v1.0'</span>,</span><span class="param"> <span class="n">origin</span><span class="o">=</span><span class="s1">''</span>,</span><span class="param"> <span class="n">symbol</span><span class="o">=</span><span class="p">[]</span>,</span><span class="param"> <span class="n">who</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">enstags</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">gz</span><span class="o">=</span><span class="kc">True</span></span>)</span>
|
||||
<span class="name">write_dobs</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">obsl</span>,</span><span class="param"> <span class="n">fname</span>,</span><span class="param"> <span class="n">name</span>,</span><span class="param"> <span class="n">spec</span><span class="o">=</span><span class="s1">'dobs v1.0'</span>,</span><span class="param"> <span class="n">origin</span><span class="o">=</span><span class="s1">''</span>,</span><span class="param"> <span class="n">symbol</span><span class="o">=</span><span class="p">[]</span>,</span><span class="param"> <span class="n">who</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">enstags</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param"> <span class="n">gz</span><span class="o">=</span><span class="kc">True</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="write_dobs-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -2015,7 +2015,11 @@ If True, the output is a gzipped XML. If False, the output is a XML file.</li>
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.input.hadrons API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -561,7 +561,7 @@
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_meson_hd5</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">filestem</span>, </span><span class="param"><span class="n">ens_id</span>, </span><span class="param"><span class="n">meson</span><span class="o">=</span><span class="s1">'meson_0'</span>, </span><span class="param"><span class="n">idl</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">gammas</span><span class="o">=</span><span class="kc">None</span></span>)</span>
|
||||
<span class="name">read_meson_hd5</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">filestem</span>, </span><span class="param"><span class="n">ens_id</span>, </span><span class="param"><span class="n">meson</span><span class="o">=</span><span class="s1">'meson_0'</span>, </span><span class="param"><span class="n">idl</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">gammas</span><span class="o">=</span><span class="kc">None</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_meson_hd5-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -662,7 +662,7 @@ If specified only configurations in the given range are read in.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_DistillationContraction_hd5</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">ens_id</span>, </span><span class="param"><span class="n">diagrams</span><span class="o">=</span><span class="p">[</span><span class="s1">'direct'</span><span class="p">]</span>, </span><span class="param"><span class="n">idl</span><span class="o">=</span><span class="kc">None</span></span>)</span>
|
||||
<span class="name">read_DistillationContraction_hd5</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">ens_id</span>, </span><span class="param"><span class="n">diagrams</span><span class="o">=</span><span class="p">[</span><span class="s1">'direct'</span><span class="p">]</span>, </span><span class="param"><span class="n">idl</span><span class="o">=</span><span class="kc">None</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_DistillationContraction_hd5-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1061,7 +1061,7 @@ in and out momenta of the propagator are exchanged.</p>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_ExternalLeg_hd5</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">filestem</span>, </span><span class="param"><span class="n">ens_id</span>, </span><span class="param"><span class="n">idl</span><span class="o">=</span><span class="kc">None</span></span>)</span>
|
||||
<span class="name">read_ExternalLeg_hd5</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">filestem</span>, </span><span class="param"><span class="n">ens_id</span>, </span><span class="param"><span class="n">idl</span><span class="o">=</span><span class="kc">None</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_ExternalLeg_hd5-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1131,7 +1131,7 @@ If specified only configurations in the given range are read in.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_Bilinear_hd5</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">filestem</span>, </span><span class="param"><span class="n">ens_id</span>, </span><span class="param"><span class="n">idl</span><span class="o">=</span><span class="kc">None</span></span>)</span>
|
||||
<span class="name">read_Bilinear_hd5</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">filestem</span>, </span><span class="param"><span class="n">ens_id</span>, </span><span class="param"><span class="n">idl</span><span class="o">=</span><span class="kc">None</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_Bilinear_hd5-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1215,7 +1215,7 @@ If specified only configurations in the given range are read in.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_Fourquark_hd5</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">filestem</span>, </span><span class="param"><span class="n">ens_id</span>, </span><span class="param"><span class="n">idl</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">vertices</span><span class="o">=</span><span class="p">[</span><span class="s1">'VA'</span><span class="p">,</span> <span class="s1">'AV'</span><span class="p">]</span></span>)</span>
|
||||
<span class="name">read_Fourquark_hd5</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">filestem</span>, </span><span class="param"><span class="n">ens_id</span>, </span><span class="param"><span class="n">idl</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="n">vertices</span><span class="o">=</span><span class="p">[</span><span class="s1">'VA'</span><span class="p">,</span> <span class="s1">'AV'</span><span class="p">]</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_Fourquark_hd5-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1426,7 +1426,11 @@ Vertex functions to be extracted.</li>
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.input.json API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -796,7 +796,7 @@
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">create_json_string</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">ol</span>, </span><span class="param"><span class="n">description</span><span class="o">=</span><span class="s1">''</span>, </span><span class="param"><span class="n">indent</span><span class="o">=</span><span class="mi">1</span></span>)</span>
|
||||
<span class="name">create_json_string</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">ol</span>, </span><span class="param"><span class="n">description</span><span class="o">=</span><span class="s1">''</span>, </span><span class="param"><span class="n">indent</span><span class="o">=</span><span class="mi">1</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="create_json_string-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1006,7 +1006,7 @@ saves disk space.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">dump_to_json</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">ol</span>, </span><span class="param"><span class="n">fname</span>, </span><span class="param"><span class="n">description</span><span class="o">=</span><span class="s1">''</span>, </span><span class="param"><span class="n">indent</span><span class="o">=</span><span class="mi">1</span>, </span><span class="param"><span class="n">gz</span><span class="o">=</span><span class="kc">True</span></span>)</span>
|
||||
<span class="name">dump_to_json</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">ol</span>, </span><span class="param"><span class="n">fname</span>, </span><span class="param"><span class="n">description</span><span class="o">=</span><span class="s1">''</span>, </span><span class="param"><span class="n">indent</span><span class="o">=</span><span class="mi">1</span>, </span><span class="param"><span class="n">gz</span><span class="o">=</span><span class="kc">True</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="dump_to_json-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1078,7 +1078,7 @@ If True, the output is a gzipped json. If False, the output is a json file.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">import_json_string</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">json_string</span>, </span><span class="param"><span class="n">verbose</span><span class="o">=</span><span class="kc">True</span>, </span><span class="param"><span class="n">full_output</span><span class="o">=</span><span class="kc">False</span></span>)</span>
|
||||
<span class="name">import_json_string</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">json_string</span>, </span><span class="param"><span class="n">verbose</span><span class="o">=</span><span class="kc">True</span>, </span><span class="param"><span class="n">full_output</span><span class="o">=</span><span class="kc">False</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="import_json_string-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1130,7 +1130,7 @@ If False, only the data is returned.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">load_json</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">fname</span>, </span><span class="param"><span class="n">verbose</span><span class="o">=</span><span class="kc">True</span>, </span><span class="param"><span class="n">gz</span><span class="o">=</span><span class="kc">True</span>, </span><span class="param"><span class="n">full_output</span><span class="o">=</span><span class="kc">False</span></span>)</span>
|
||||
<span class="name">load_json</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">fname</span>, </span><span class="param"><span class="n">verbose</span><span class="o">=</span><span class="kc">True</span>, </span><span class="param"><span class="n">gz</span><span class="o">=</span><span class="kc">True</span>, </span><span class="param"><span class="n">full_output</span><span class="o">=</span><span class="kc">False</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="load_json-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1198,7 +1198,7 @@ If False, only the data is returned.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">dump_dict_to_json</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">od</span>, </span><span class="param"><span class="n">fname</span>, </span><span class="param"><span class="n">description</span><span class="o">=</span><span class="s1">''</span>, </span><span class="param"><span class="n">indent</span><span class="o">=</span><span class="mi">1</span>, </span><span class="param"><span class="n">reps</span><span class="o">=</span><span class="s1">'DICTOBS'</span>, </span><span class="param"><span class="n">gz</span><span class="o">=</span><span class="kc">True</span></span>)</span>
|
||||
<span class="name">dump_dict_to_json</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">od</span>, </span><span class="param"><span class="n">fname</span>, </span><span class="param"><span class="n">description</span><span class="o">=</span><span class="s1">''</span>, </span><span class="param"><span class="n">indent</span><span class="o">=</span><span class="mi">1</span>, </span><span class="param"><span class="n">reps</span><span class="o">=</span><span class="s1">'DICTOBS'</span>, </span><span class="param"><span class="n">gz</span><span class="o">=</span><span class="kc">True</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="dump_dict_to_json-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1271,7 +1271,7 @@ If True, the output is a gzipped json. If False, the output is a json file.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">load_json_dict</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">fname</span>, </span><span class="param"><span class="n">verbose</span><span class="o">=</span><span class="kc">True</span>, </span><span class="param"><span class="n">gz</span><span class="o">=</span><span class="kc">True</span>, </span><span class="param"><span class="n">full_output</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="n">reps</span><span class="o">=</span><span class="s1">'DICTOBS'</span></span>)</span>
|
||||
<span class="name">load_json_dict</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">fname</span>, </span><span class="param"><span class="n">verbose</span><span class="o">=</span><span class="kc">True</span>, </span><span class="param"><span class="n">gz</span><span class="o">=</span><span class="kc">True</span>, </span><span class="param"><span class="n">full_output</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="n">reps</span><span class="o">=</span><span class="s1">'DICTOBS'</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="load_json_dict-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1437,7 +1437,11 @@ Specify the structure of the placeholder in imported dict to be reps[0-9]+.</li>
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.input.misc API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -202,7 +202,7 @@
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_pbp</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">prefix</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">read_pbp</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">prefix</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_pbp-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -442,7 +442,11 @@ list which contains the last config to be read for each replicum</li>
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.input.openQCD API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -1071,7 +1071,7 @@
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_rwms</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">prefix</span>, </span><span class="param"><span class="n">version</span><span class="o">=</span><span class="s1">'2.0'</span>, </span><span class="param"><span class="n">names</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">read_rwms</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">prefix</span>, </span><span class="param"><span class="n">version</span><span class="o">=</span><span class="s1">'2.0'</span>, </span><span class="param"><span class="n">names</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_rwms-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1337,7 +1337,7 @@ Print additional information that is useful for debugging.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">extract_t0</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">prefix</span>, </span><span class="param"><span class="n">dtr_read</span>, </span><span class="param"><span class="n">xmin</span>, </span><span class="param"><span class="n">spatial_extent</span>, </span><span class="param"><span class="n">fit_range</span><span class="o">=</span><span class="mi">5</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">extract_t0</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">prefix</span>, </span><span class="param"><span class="n">dtr_read</span>, </span><span class="param"><span class="n">xmin</span>, </span><span class="param"><span class="n">spatial_extent</span>, </span><span class="param"><span class="n">fit_range</span><span class="o">=</span><span class="mi">5</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="extract_t0-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1654,7 +1654,7 @@ If False: The config numbers are assumed to be traj_number // difference</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_qtop</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">prefix</span>, </span><span class="param"><span class="n">c</span>, </span><span class="param"><span class="n">dtr_cnfg</span><span class="o">=</span><span class="mi">1</span>, </span><span class="param"><span class="n">version</span><span class="o">=</span><span class="s1">'openQCD'</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">read_qtop</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">prefix</span>, </span><span class="param"><span class="n">c</span>, </span><span class="param"><span class="n">dtr_cnfg</span><span class="o">=</span><span class="mi">1</span>, </span><span class="param"><span class="n">version</span><span class="o">=</span><span class="s1">'openQCD'</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_qtop-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1758,7 +1758,7 @@ If True, the charge is rounded towards the nearest integer on each config.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_gf_coupling</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">prefix</span>, </span><span class="param"><span class="n">c</span>, </span><span class="param"><span class="n">dtr_cnfg</span><span class="o">=</span><span class="mi">1</span>, </span><span class="param"><span class="n">Zeuthen_flow</span><span class="o">=</span><span class="kc">True</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">read_gf_coupling</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">prefix</span>, </span><span class="param"><span class="n">c</span>, </span><span class="param"><span class="n">dtr_cnfg</span><span class="o">=</span><span class="mi">1</span>, </span><span class="param"><span class="n">Zeuthen_flow</span><span class="o">=</span><span class="kc">True</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_gf_coupling-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1879,7 +1879,7 @@ Has to have the appropriate length.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">qtop_projection</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">qtop</span>, </span><span class="param"><span class="n">target</span><span class="o">=</span><span class="mi">0</span></span>)</span>
|
||||
<span class="name">qtop_projection</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">qtop</span>, </span><span class="param"><span class="n">target</span><span class="o">=</span><span class="mi">0</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="qtop_projection-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -1927,7 +1927,7 @@ Specifies the topological sector to be reweighted to (default 0)</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_qtop_sector</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">prefix</span>, </span><span class="param"><span class="n">c</span>, </span><span class="param"><span class="n">target</span><span class="o">=</span><span class="mi">0</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">read_qtop_sector</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span>, </span><span class="param"><span class="n">prefix</span>, </span><span class="param"><span class="n">c</span>, </span><span class="param"><span class="n">target</span><span class="o">=</span><span class="mi">0</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_qtop_sector-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -2137,7 +2137,11 @@ for version=='sfqcd' If False, the Wilson flow is used.</li>
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.input.pandas API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -240,7 +240,7 @@
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">to_sql</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">df</span>, </span><span class="param"><span class="n">table_name</span>, </span><span class="param"><span class="n">db</span>, </span><span class="param"><span class="n">if_exists</span><span class="o">=</span><span class="s1">'fail'</span>, </span><span class="param"><span class="n">gz</span><span class="o">=</span><span class="kc">True</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">to_sql</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">df</span>, </span><span class="param"><span class="n">table_name</span>, </span><span class="param"><span class="n">db</span>, </span><span class="param"><span class="n">if_exists</span><span class="o">=</span><span class="s1">'fail'</span>, </span><span class="param"><span class="n">gz</span><span class="o">=</span><span class="kc">True</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="to_sql-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -294,7 +294,7 @@ If True the json strings are gzipped.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_sql</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">sql</span>, </span><span class="param"><span class="n">db</span>, </span><span class="param"><span class="n">auto_gamma</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">read_sql</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">sql</span>, </span><span class="param"><span class="n">db</span>, </span><span class="param"><span class="n">auto_gamma</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_sql-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -342,7 +342,7 @@ the error analysis. Default False.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">dump_df</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">df</span>, </span><span class="param"><span class="n">fname</span>, </span><span class="param"><span class="n">gz</span><span class="o">=</span><span class="kc">True</span></span>)</span>
|
||||
<span class="name">dump_df</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">df</span>, </span><span class="param"><span class="n">fname</span>, </span><span class="param"><span class="n">gz</span><span class="o">=</span><span class="kc">True</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="dump_df-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -401,7 +401,7 @@ If True, the output is a gzipped csv file. If False, the output is a csv file.</
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">load_df</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">fname</span>, </span><span class="param"><span class="n">auto_gamma</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="n">gz</span><span class="o">=</span><span class="kc">True</span></span>)</span>
|
||||
<span class="name">load_df</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">fname</span>, </span><span class="param"><span class="n">auto_gamma</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="n">gz</span><span class="o">=</span><span class="kc">True</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="load_df-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -557,7 +557,11 @@ If True, assumes that data is gzipped. If False, assumes JSON file.</li>
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.input.sfcf API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -437,7 +437,7 @@
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_sfcf</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">path</span>,</span><span class="param"> <span class="n">prefix</span>,</span><span class="param"> <span class="n">name</span>,</span><span class="param"> <span class="n">quarks</span><span class="o">=</span><span class="s1">'.*'</span>,</span><span class="param"> <span class="n">corr_type</span><span class="o">=</span><span class="s1">'bi'</span>,</span><span class="param"> <span class="n">noffset</span><span class="o">=</span><span class="mi">0</span>,</span><span class="param"> <span class="n">wf</span><span class="o">=</span><span class="mi">0</span>,</span><span class="param"> <span class="n">wf2</span><span class="o">=</span><span class="mi">0</span>,</span><span class="param"> <span class="n">version</span><span class="o">=</span><span class="s1">'1.0c'</span>,</span><span class="param"> <span class="n">cfg_separator</span><span class="o">=</span><span class="s1">'n'</span>,</span><span class="param"> <span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">read_sfcf</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">path</span>,</span><span class="param"> <span class="n">prefix</span>,</span><span class="param"> <span class="n">name</span>,</span><span class="param"> <span class="n">quarks</span><span class="o">=</span><span class="s1">'.*'</span>,</span><span class="param"> <span class="n">corr_type</span><span class="o">=</span><span class="s1">'bi'</span>,</span><span class="param"> <span class="n">noffset</span><span class="o">=</span><span class="mi">0</span>,</span><span class="param"> <span class="n">wf</span><span class="o">=</span><span class="mi">0</span>,</span><span class="param"> <span class="n">wf2</span><span class="o">=</span><span class="mi">0</span>,</span><span class="param"> <span class="n">version</span><span class="o">=</span><span class="s1">'1.0c'</span>,</span><span class="param"> <span class="n">cfg_separator</span><span class="o">=</span><span class="s1">'n'</span>,</span><span class="param"> <span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="read_sfcf-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -946,7 +946,11 @@ for one replicum with 1000 configs</li>
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.input.utils API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -106,7 +106,7 @@
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">check_idl</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">idl</span>, </span><span class="param"><span class="n">che</span></span>)</span>
|
||||
<span class="name">check_idl</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">idl</span>, </span><span class="param"><span class="n">che</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="check_idl-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -253,7 +253,11 @@ list of configurations to be checked against</li>
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.linalg API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -391,7 +391,7 @@
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">matmul</span><span class="signature pdoc-code condensed">(<span class="param"><span class="o">*</span><span class="n">operands</span></span>)</span>
|
||||
<span class="name">matmul</span><span class="signature pdoc-code condensed">(<span class="param"><span class="o">*</span><span class="n">operands</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="matmul-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -473,7 +473,7 @@ Obs valued.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">jack_matmul</span><span class="signature pdoc-code condensed">(<span class="param"><span class="o">*</span><span class="n">operands</span></span>)</span>
|
||||
<span class="name">jack_matmul</span><span class="signature pdoc-code condensed">(<span class="param"><span class="o">*</span><span class="n">operands</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="jack_matmul-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -560,7 +560,7 @@ Obs valued.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">einsum</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">subscripts</span>, </span><span class="param"><span class="o">*</span><span class="n">operands</span></span>)</span>
|
||||
<span class="name">einsum</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">subscripts</span>, </span><span class="param"><span class="o">*</span><span class="n">operands</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="einsum-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -661,7 +661,7 @@ Obs valued.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">inv</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span></span>)</span>
|
||||
<span class="name">inv</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="inv-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -683,7 +683,7 @@ Obs valued.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">cholesky</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span></span>)</span>
|
||||
<span class="name">cholesky</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="cholesky-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -707,7 +707,7 @@ Obs valued.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">det</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span></span>)</span>
|
||||
<span class="name">det</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="det-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -729,7 +729,7 @@ Obs valued.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">eigh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obs</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">eigh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obs</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="eigh-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -753,7 +753,7 @@ Obs valued.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">eig</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obs</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">eig</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obs</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="eig-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -776,7 +776,7 @@ Obs valued.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">pinv</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obs</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">pinv</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obs</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="pinv-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -798,7 +798,7 @@ Obs valued.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">svd</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obs</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">svd</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obs</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="svd-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -921,7 +921,11 @@ Obs valued.</li>
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.misc API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -209,7 +209,7 @@
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">dump_object</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obj</span>, </span><span class="param"><span class="n">name</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">dump_object</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obj</span>, </span><span class="param"><span class="n">name</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="dump_object-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -257,7 +257,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">load_object</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span></span>)</span>
|
||||
<span class="name">load_object</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">path</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="load_object-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -293,7 +293,7 @@ path to the file</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">pseudo_Obs</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">value</span>, </span><span class="param"><span class="n">dvalue</span>, </span><span class="param"><span class="n">name</span>, </span><span class="param"><span class="n">samples</span><span class="o">=</span><span class="mi">1000</span></span>)</span>
|
||||
<span class="name">pseudo_Obs</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">value</span>, </span><span class="param"><span class="n">dvalue</span>, </span><span class="param"><span class="n">name</span>, </span><span class="param"><span class="n">samples</span><span class="o">=</span><span class="mi">1000</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="pseudo_Obs-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -355,7 +355,7 @@ number of samples for the Obs (default 1000).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">gen_correlated_data</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">means</span>, </span><span class="param"><span class="n">cov</span>, </span><span class="param"><span class="n">name</span>, </span><span class="param"><span class="n">tau</span><span class="o">=</span><span class="mf">0.5</span>, </span><span class="param"><span class="n">samples</span><span class="o">=</span><span class="mi">1000</span></span>)</span>
|
||||
<span class="name">gen_correlated_data</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">means</span>, </span><span class="param"><span class="n">cov</span>, </span><span class="param"><span class="n">name</span>, </span><span class="param"><span class="n">tau</span><span class="o">=</span><span class="mf">0.5</span>, </span><span class="param"><span class="n">samples</span><span class="o">=</span><span class="mi">1000</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="gen_correlated_data-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -523,7 +523,11 @@ number of samples to be generated for each observable.</li>
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.mpm API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -138,7 +138,7 @@
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">matrix_pencil_method</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">corrs</span>, </span><span class="param"><span class="n">k</span><span class="o">=</span><span class="mi">1</span>, </span><span class="param"><span class="n">p</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">matrix_pencil_method</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">corrs</span>, </span><span class="param"><span class="n">k</span><span class="o">=</span><span class="mi">1</span>, </span><span class="param"><span class="n">p</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="matrix_pencil_method-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -324,7 +324,11 @@ to len(data)/2 but could possibly suppress more noise (default len(data)//2).</l
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.obs API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -3243,7 +3243,7 @@ list of ranges or lists on which the samples are defined</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">gamma_method</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">gamma_method</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.gamma_method-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3442,7 +3442,7 @@ of the autocorrelation function (default True)</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">details</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">ens_content</span><span class="o">=</span><span class="kc">True</span></span>)</span>
|
||||
<span class="name">details</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">ens_content</span><span class="o">=</span><span class="kc">True</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.details-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3528,7 +3528,7 @@ print details about the ensembles and replica if true.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">reweight</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">weight</span></span>)</span>
|
||||
<span class="name">reweight</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">weight</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.reweight-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3573,7 +3573,7 @@ on the configurations in obs[i].idl. Default False.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">is_zero_within_error</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">sigma</span><span class="o">=</span><span class="mi">1</span></span>)</span>
|
||||
<span class="name">is_zero_within_error</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">sigma</span><span class="o">=</span><span class="mi">1</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.is_zero_within_error-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3611,7 +3611,7 @@ Number of standard errors used for the check.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">is_zero</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">atol</span><span class="o">=</span><span class="mf">1e-10</span></span>)</span>
|
||||
<span class="name">is_zero</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">atol</span><span class="o">=</span><span class="mf">1e-10</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.is_zero-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3646,7 +3646,7 @@ Absolute tolerance (for details see numpy documentation).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">plot_tauint</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">save</span><span class="o">=</span><span class="kc">None</span></span>)</span>
|
||||
<span class="name">plot_tauint</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">save</span><span class="o">=</span><span class="kc">None</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.plot_tauint-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3711,7 +3711,7 @@ saves the figure to a file named 'save' if.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">plot_rho</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">save</span><span class="o">=</span><span class="kc">None</span></span>)</span>
|
||||
<span class="name">plot_rho</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">save</span><span class="o">=</span><span class="kc">None</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.plot_rho-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3767,7 +3767,7 @@ saves the figure to a file named 'save' if.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">plot_rep_dist</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">plot_rep_dist</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.plot_rep_dist-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3807,7 +3807,7 @@ saves the figure to a file named 'save' if.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">plot_history</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">expand</span><span class="o">=</span><span class="kc">True</span></span>)</span>
|
||||
<span class="name">plot_history</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">expand</span><span class="o">=</span><span class="kc">True</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.plot_history-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3864,7 +3864,7 @@ show expanded history for irregular Monte Carlo chains (default: True).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">plot_piechart</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">save</span><span class="o">=</span><span class="kc">None</span></span>)</span>
|
||||
<span class="name">plot_piechart</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">save</span><span class="o">=</span><span class="kc">None</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.plot_piechart-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3914,7 +3914,7 @@ saves the figure to a file named 'save' if.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">dump</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">filename</span>, </span><span class="param"><span class="n">datatype</span><span class="o">=</span><span class="s1">'json.gz'</span>, </span><span class="param"><span class="n">description</span><span class="o">=</span><span class="s1">''</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">dump</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">filename</span>, </span><span class="param"><span class="n">datatype</span><span class="o">=</span><span class="s1">'json.gz'</span>, </span><span class="param"><span class="n">description</span><span class="o">=</span><span class="s1">''</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.dump-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -3975,7 +3975,7 @@ specifies a custom path for the file (default '.')</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">export_jackknife</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">export_jackknife</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.export_jackknife-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4030,7 +4030,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">sqrt</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">sqrt</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.sqrt-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4049,7 +4049,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">log</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">log</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.log-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4068,7 +4068,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">exp</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">exp</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.exp-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4087,7 +4087,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">sin</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">sin</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.sin-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4106,7 +4106,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">cos</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">cos</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.cos-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4125,7 +4125,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">tan</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">tan</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.tan-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4144,7 +4144,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">arcsin</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">arcsin</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.arcsin-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4163,7 +4163,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">arccos</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">arccos</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.arccos-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4182,7 +4182,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">arctan</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">arctan</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.arctan-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4201,7 +4201,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">sinh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">sinh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.sinh-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4220,7 +4220,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">cosh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">cosh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.cosh-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4239,7 +4239,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">tanh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">tanh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.tanh-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4258,7 +4258,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">arcsinh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">arcsinh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.arcsinh-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4277,7 +4277,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">arccosh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">arccosh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.arccosh-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4296,7 +4296,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">arctanh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">arctanh</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="Obs.arctanh-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4628,7 +4628,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">gamma_method</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">gamma_method</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="CObs.gamma_method-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4653,7 +4653,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">is_zero</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">is_zero</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="CObs.is_zero-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4675,7 +4675,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">conjugate</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span>)</span>
|
||||
<span class="name">conjugate</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="CObs.conjugate-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4695,7 +4695,7 @@ should agree with samples from a full jackknife analysis up to O(1/N).</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">derived_observable</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">func</span>, </span><span class="param"><span class="n">data</span>, </span><span class="param"><span class="n">array_mode</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">derived_observable</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">func</span>, </span><span class="param"><span class="n">data</span>, </span><span class="param"><span class="n">array_mode</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="derived_observable-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4919,7 +4919,7 @@ functions. For the ratio of two observables one can e.g. use</p>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">reweight</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">weight</span>, </span><span class="param"><span class="n">obs</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">reweight</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">weight</span>, </span><span class="param"><span class="n">obs</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="reweight-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -4993,7 +4993,7 @@ on the configurations in obs[i].idl. Default False.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">correlate</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obs_a</span>, </span><span class="param"><span class="n">obs_b</span></span>)</span>
|
||||
<span class="name">correlate</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obs_a</span>, </span><span class="param"><span class="n">obs_b</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="correlate-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -5069,7 +5069,7 @@ Currently only works if ensembles are identical (this is not strictly necessary)
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">covariance</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obs</span>, </span><span class="param"><span class="n">visualize</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="n">correlation</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="n">smooth</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">covariance</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">obs</span>, </span><span class="param"><span class="n">visualize</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="n">correlation</span><span class="o">=</span><span class="kc">False</span>, </span><span class="param"><span class="n">smooth</span><span class="o">=</span><span class="kc">None</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="covariance-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -5182,7 +5182,7 @@ This construction ensures that the estimated covariance matrix is positive semi-
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">import_jackknife</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">jacks</span>, </span><span class="param"><span class="n">name</span>, </span><span class="param"><span class="n">idl</span><span class="o">=</span><span class="kc">None</span></span>)</span>
|
||||
<span class="name">import_jackknife</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">jacks</span>, </span><span class="param"><span class="n">name</span>, </span><span class="param"><span class="n">idl</span><span class="o">=</span><span class="kc">None</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="import_jackknife-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -5229,7 +5229,7 @@ name of the ensemble the samples are defined on.</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">merge_obs</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">list_of_obs</span></span>)</span>
|
||||
<span class="name">merge_obs</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">list_of_obs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="merge_obs-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -5288,7 +5288,7 @@ list of the Obs object to be combined</li>
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">cov_Obs</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">means</span>, </span><span class="param"><span class="n">cov</span>, </span><span class="param"><span class="n">name</span>, </span><span class="param"><span class="n">grad</span><span class="o">=</span><span class="kc">None</span></span>)</span>
|
||||
<span class="name">cov_Obs</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">means</span>, </span><span class="param"><span class="n">cov</span>, </span><span class="param"><span class="n">name</span>, </span><span class="param"><span class="n">grad</span><span class="o">=</span><span class="kc">None</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="cov_Obs-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -5459,7 +5459,11 @@ Gradient of the Covobs wrt. the means belonging to cov.</li>
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.roots API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -121,7 +121,7 @@
|
|||
<div class="attr function">
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">find_root</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">d</span>, </span><span class="param"><span class="n">func</span>, </span><span class="param"><span class="n">guess</span><span class="o">=</span><span class="mf">1.0</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
|
||||
<span class="name">find_root</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">d</span>, </span><span class="param"><span class="n">func</span>, </span><span class="param"><span class="n">guess</span><span class="o">=</span><span class="mf">1.0</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span>
|
||||
|
||||
<label class="view-source-button" for="find_root-view-source"><span>View Source</span></label>
|
||||
|
||||
|
|
@ -172,16 +172,16 @@
|
|||
<ul>
|
||||
<li><strong>d</strong> (Obs):
|
||||
Obs passed to the function.</li>
|
||||
<li><strong>func</strong> (object):
|
||||
<li><p><strong>func</strong> (object):
|
||||
Function to be minimized. Any numpy functions have to use the autograd.numpy wrapper.
|
||||
Example:
|
||||
<code>python
|
||||
import autograd.numpy as anp
|
||||
def root_func(x, d):
|
||||
return anp.exp(-x ** 2) - d
|
||||
</code></li>
|
||||
<li><strong>guess</strong> (float):
|
||||
Initial guess for the minimization.</li>
|
||||
Example:</p>
|
||||
|
||||
<div class="pdoc-code codehilite"><pre><span></span><code><span class="kn">import</span> <span class="nn">autograd.numpy</span> <span class="k">as</span> <span class="nn">anp</span>
|
||||
<span class="k">def</span> <span class="nf">root_func</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">d</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="n">anp</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="o">-</span><span class="n">x</span> <span class="o">**</span> <span class="mi">2</span><span class="p">)</span> <span class="o">-</span> <span class="n">d</span>
|
||||
</code></pre></div></li>
|
||||
<li><p><strong>guess</strong> (float):
|
||||
Initial guess for the minimization.</p></li>
|
||||
</ul>
|
||||
|
||||
<h6 id="returns">Returns</h6>
|
||||
|
|
@ -296,7 +296,11 @@ Initial guess for the minimization.</li>
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="generator" content="pdoc 12.0.2"/>
|
||||
<meta name="generator" content="pdoc 12.1.0"/>
|
||||
<title>pyerrors.version API documentation</title>
|
||||
|
||||
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
|
||||
|
|
@ -172,7 +172,11 @@
|
|||
let heading;
|
||||
switch (result.doc.type) {
|
||||
case "function":
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span><span class="signature">${doc.signature}:</span>`;
|
||||
if (doc.fullname.endsWith(".__init__")) {
|
||||
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
|
||||
} else {
|
||||
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
|
||||
}
|
||||
break;
|
||||
case "class":
|
||||
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
Loading…
Add table
Add a link
Reference in a new issue