Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@gplepage
gplepage committed May 12, 2022
1 parent acafa30 commit 3cbf0e0
Show file tree
Hide file tree
Showing 16 changed files with 65 additions and 52 deletions.
2 changes: 1 addition & 1 deletion doc/html/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 8148f7ac739c3da429899a724fc33450
config: 1843a3c44237f3e1d2f4bdb9c6525f1c
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified doc/html/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified doc/html/.doctrees/gvar.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion doc/html/_static/documentation_options.js
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '11.9.7',
VERSION: '11.10',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
6 changes: 3 additions & 3 deletions doc/html/case-pendulum.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<title>Case Study: Numerical Analysis — Pendulum Clock &#8212; gvar 11.9.7 documentation</title>
<title>Case Study: Numerical Analysis — Pendulum Clock &#8212; gvar 11.10 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/pyramid.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
Expand Down Expand Up @@ -40,7 +40,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="gvar_other.html" title="Numerical Analysis Modules in gvar"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">gvar 11.9.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">gvar 11.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Case Study: Numerical Analysis — Pendulum Clock</a></li>
</ul>
</div>
Expand Down Expand Up @@ -266,7 +266,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="gvar_other.html" title="Numerical Analysis Modules in gvar"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">gvar 11.9.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">gvar 11.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Case Study: Numerical Analysis — Pendulum Clock</a></li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions doc/html/case-svdcut.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<title>Case Study: Correlations and SVD Cuts &#8212; gvar 11.9.7 documentation</title>
<title>Case Study: Correlations and SVD Cuts &#8212; gvar 11.10 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/pyramid.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
Expand Down Expand Up @@ -36,7 +36,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="case-pendulum.html" title="Case Study: Numerical Analysis — Pendulum Clock"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">gvar 11.9.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">gvar 11.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Case Study: Correlations and SVD Cuts</a></li>
</ul>
</div>
Expand Down Expand Up @@ -286,7 +286,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="case-pendulum.html" title="Case Study: Numerical Analysis — Pendulum Clock"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">gvar 11.9.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">gvar 11.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Case Study: Correlations and SVD Cuts</a></li>
</ul>
</div>
Expand Down
20 changes: 10 additions & 10 deletions doc/html/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; gvar 11.9.7 documentation</title>
<title>Index &#8212; gvar 11.10 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/pyramid.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
Expand All @@ -31,7 +31,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">gvar 11.9.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">gvar 11.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
</ul>
</div>
Expand Down Expand Up @@ -133,7 +133,7 @@ <h2 id="C">C</h2>
</li>
<li><a href="gvar.html#gvar.corr">corr() (in module gvar)</a>
</li>
<li><a href="gvar.html#gvar.gmod.correction">correction (gvar.gmod attribute)</a>, <a href="gvar.html#id13">[1]</a>
<li><a href="gvar.html#gvar.gmod.correction">correction (gvar.gmod attribute)</a>, <a href="gvar.html#id14">[1]</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
Expand Down Expand Up @@ -185,7 +185,7 @@ <h2 id="D">D</h2>
</li>
<li><a href="gvar.html#gvar.distribute_gvars">distribute_gvars() (in module gvar)</a>
</li>
<li><a href="gvar.html#gvar.gmod.dof">dof (gvar.gmod attribute)</a>, <a href="gvar.html#id9">[1]</a>
<li><a href="gvar.html#gvar.gmod.dof">dof (gvar.gmod attribute)</a>, <a href="gvar.html#id10">[1]</a>
</li>
<li><a href="gvar.html#gvar.GVar.dotder">dotder() (gvar.GVar method)</a>
</li>
Expand Down Expand Up @@ -304,7 +304,7 @@ <h2 id="G">G</h2>
<li><a href="gvar_dataset.html#module-gvar.dataset">module</a>
</li>
</ul></li>
<li><a href="gvar.html#gvar.gvar.gvar">gvar.gvar() (in module gvar)</a>, <a href="gvar.html#id0">[1]</a>, <a href="gvar.html#id1">[2]</a>, <a href="gvar.html#id2">[3]</a>, <a href="gvar.html#id3">[4]</a>, <a href="gvar.html#id4">[5]</a>, <a href="gvar.html#id5">[6]</a>, <a href="gvar.html#id6">[7]</a>, <a href="gvar.html#id7">[8]</a>
<li><a href="gvar.html#gvar.gvar.gvar">gvar.gvar() (in module gvar)</a>, <a href="gvar.html#id0">[1]</a>, <a href="gvar.html#id1">[2]</a>, <a href="gvar.html#id2">[3]</a>, <a href="gvar.html#id3">[4]</a>, <a href="gvar.html#id4">[5]</a>, <a href="gvar.html#id5">[6]</a>, <a href="gvar.html#id6">[7]</a>, <a href="gvar.html#id7">[8]</a>, <a href="gvar.html#id8">[9]</a>
</li>
<li>
gvar.linalg
Expand Down Expand Up @@ -382,7 +382,7 @@ <h2 id="L">L</h2>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="gvar.html#gvar.gmod.logdet">logdet (gvar.gmod attribute)</a>, <a href="gvar.html#id12">[1]</a>
<li><a href="gvar.html#gvar.gmod.logdet">logdet (gvar.gmod attribute)</a>, <a href="gvar.html#id13">[1]</a>
</li>
<li><a href="gvar_other.html#gvar.linalg.lstsq">lstsq() (gvar.linalg method)</a>
</li>
Expand Down Expand Up @@ -439,12 +439,12 @@ <h2 id="M">M</h2>
<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="gvar.html#gvar.gmod.nblocks">nblocks (gvar.gmod attribute)</a>, <a href="gvar.html#id11">[1]</a>
<li><a href="gvar.html#gvar.gmod.nblocks">nblocks (gvar.gmod attribute)</a>, <a href="gvar.html#id12">[1]</a>
</li>
<li><a href="gvar_dataset.html#gvar.dataset.svd_diagnosis.nmod">nmod (gvar.dataset.svd_diagnosis attribute)</a>

<ul>
<li><a href="gvar.html#gvar.gmod.nmod">(gvar.gmod attribute)</a>, <a href="gvar.html#id10">[1]</a>
<li><a href="gvar.html#gvar.gmod.nmod">(gvar.gmod attribute)</a>, <a href="gvar.html#id11">[1]</a>
</li>
<li><a href="gvar.html#gvar.SVD.nmod">(gvar.SVD attribute)</a>
</li>
Expand Down Expand Up @@ -566,7 +566,7 @@ <h2 id="S">S</h2>
<li><a href="gvar_dataset.html#gvar.dataset.svd_diagnosis.svdcut">svdcut (gvar.dataset.svd_diagnosis attribute)</a>

<ul>
<li><a href="gvar.html#gvar.gmod.svdcut">(gvar.gmod attribute)</a>, <a href="gvar.html#id8">[1]</a>
<li><a href="gvar.html#gvar.gmod.svdcut">(gvar.gmod attribute)</a>, <a href="gvar.html#id9">[1]</a>
</li>
</ul></li>
<li><a href="gvar.html#gvar.switch_gvar">switch_gvar() (in module gvar)</a>
Expand Down Expand Up @@ -663,7 +663,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">gvar 11.9.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">gvar 11.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
</ul>
</div>
Expand Down
43 changes: 28 additions & 15 deletions doc/html/gvar.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<title>gvar - Gaussian Random Variables &#8212; gvar 11.9.7 documentation</title>
<title>gvar - Gaussian Random Variables &#8212; gvar 11.10 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/pyramid.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
Expand Down Expand Up @@ -40,7 +40,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="overview.html" title="Overview and Tutorial"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">gvar 11.9.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">gvar 11.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">gvar</span></code> - Gaussian Random Variables</a></li>
</ul>
</div>
Expand Down Expand Up @@ -226,6 +226,19 @@ <h2>Functions<a class="headerlink" href="#functions" title="Permalink to this he
above).</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="id8">
<span class="sig-prename descclassname"><span class="pre">gvar.</span></span><span class="sig-name descname"><span class="pre">gvar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ymean</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ycov</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xycov</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#id8" title="Permalink to this definition"></a></dt>
<dd><p>Returns a 1-d array of <a class="reference internal" href="#gvar.GVar" title="gvar.GVar"><code class="xref py py-class docutils literal notranslate"><span class="pre">gvar.GVar</span></code></a>s <code class="docutils literal notranslate"><span class="pre">y[i]</span></code> constructed from the 1-d array
of mean values <code class="docutils literal notranslate"><span class="pre">ymean</span></code> and the 2-d covariance matrix <code class="docutils literal notranslate"><span class="pre">ycov</span></code>. The
<code class="docutils literal notranslate"><span class="pre">y[i]</span></code> are correlated with the primary <a class="reference internal" href="#gvar.GVar" title="gvar.GVar"><code class="xref py py-class docutils literal notranslate"><span class="pre">gvar.GVar</span></code></a>s in 1-d array <code class="docutils literal notranslate"><span class="pre">x</span></code>.
The <code class="docutils literal notranslate"><span class="pre">x-y</span></code> covariance matrix is <code class="docutils literal notranslate"><span class="pre">xycov</span></code> whose shape
is <code class="docutils literal notranslate"><span class="pre">x.shape</span> <span class="pre">+</span> <span class="pre">y.shape</span></code>. Note that this changes the <a class="reference internal" href="#gvar.GVar" title="gvar.GVar"><code class="xref py py-class docutils literal notranslate"><span class="pre">gvar.GVar</span></code></a>s
in <code class="docutils literal notranslate"><span class="pre">x</span></code> (because they are correlated with the <code class="docutils literal notranslate"><span class="pre">y[i]</span></code>); it
has no effect on the variance or on correlations between
different <code class="docutils literal notranslate"><span class="pre">x[i]</span></code>s.</p>
</dd></dl>

</dd></dl>

<p>The following function is useful for constructing new functions that
Expand Down Expand Up @@ -1818,29 +1831,29 @@ <h2>Functions<a class="headerlink" href="#functions" title="Permalink to this he
</dl>
<p>Data from the SVD analysis is stored in <code class="docutils literal notranslate"><span class="pre">gmod</span></code>:</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="id8">
<span class="sig-prename descclassname"><span class="pre">gmod.</span></span><span class="sig-name descname"><span class="pre">svdcut</span></span><a class="headerlink" href="#id8" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="id9">
<span class="sig-prename descclassname"><span class="pre">gmod.</span></span><span class="sig-name descname"><span class="pre">svdcut</span></span><a class="headerlink" href="#id9" title="Permalink to this definition"></a></dt>
<dd><p>SVD cut used to create <code class="docutils literal notranslate"><span class="pre">gmod</span></code>.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="id9">
<span class="sig-prename descclassname"><span class="pre">gmod.</span></span><span class="sig-name descname"><span class="pre">dof</span></span><a class="headerlink" href="#id9" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="id10">
<span class="sig-prename descclassname"><span class="pre">gmod.</span></span><span class="sig-name descname"><span class="pre">dof</span></span><a class="headerlink" href="#id10" title="Permalink to this definition"></a></dt>
<dd><p>Number of independent degrees of freedom left after the
SVD cut. This is the same as the number initially unless
<code class="docutils literal notranslate"><span class="pre">svdcut</span> <span class="pre">&lt;</span> <span class="pre">0</span></code> in which case it may be smaller.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="id10">
<span class="sig-prename descclassname"><span class="pre">gmod.</span></span><span class="sig-name descname"><span class="pre">nmod</span></span><a class="headerlink" href="#id10" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="id11">
<span class="sig-prename descclassname"><span class="pre">gmod.</span></span><span class="sig-name descname"><span class="pre">nmod</span></span><a class="headerlink" href="#id11" title="Permalink to this definition"></a></dt>
<dd><p>Number of modes whose eignevalue was modified by the
SVD cut.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="id11">
<span class="sig-prename descclassname"><span class="pre">gmod.</span></span><span class="sig-name descname"><span class="pre">nblocks</span></span><a class="headerlink" href="#id11" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="id12">
<span class="sig-prename descclassname"><span class="pre">gmod.</span></span><span class="sig-name descname"><span class="pre">nblocks</span></span><a class="headerlink" href="#id12" title="Permalink to this definition"></a></dt>
<dd><p>A dictionary where <code class="docutils literal notranslate"><span class="pre">gmod.nblocks[s]</span></code> contains the number of
block-diagonal <code class="docutils literal notranslate"><span class="pre">s</span></code>-by-<code class="docutils literal notranslate"><span class="pre">s</span></code> sub-matrices in the correlation
matrix.</p>
Expand All @@ -1854,16 +1867,16 @@ <h2>Functions<a class="headerlink" href="#functions" title="Permalink to this he
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="id12">
<span class="sig-prename descclassname"><span class="pre">gmod.</span></span><span class="sig-name descname"><span class="pre">logdet</span></span><a class="headerlink" href="#id12" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="id13">
<span class="sig-prename descclassname"><span class="pre">gmod.</span></span><span class="sig-name descname"><span class="pre">logdet</span></span><a class="headerlink" href="#id13" title="Permalink to this definition"></a></dt>
<dd><p>Logarithm of the determinant of the covariance matrix after SVD
cuts are applied (excluding any omitted modes when
<code class="docutils literal notranslate"><span class="pre">svdcut</span> <span class="pre">&lt;</span> <span class="pre">0</span></code> and any diagonal zero modes).</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="id13">
<span class="sig-prename descclassname"><span class="pre">gmod.</span></span><span class="sig-name descname"><span class="pre">correction</span></span><a class="headerlink" href="#id13" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="id14">
<span class="sig-prename descclassname"><span class="pre">gmod.</span></span><span class="sig-name descname"><span class="pre">correction</span></span><a class="headerlink" href="#id14" title="Permalink to this definition"></a></dt>
<dd><p>Array or dictionary containing the SVD corrections added to <code class="docutils literal notranslate"><span class="pre">g</span></code>
to create <code class="docutils literal notranslate"><span class="pre">gmod</span></code>: <code class="docutils literal notranslate"><span class="pre">gmod</span> <span class="pre">=</span> <span class="pre">g</span> <span class="pre">+</span> <span class="pre">gmod.correction</span></code>.</p>
</dd></dl>
Expand Down Expand Up @@ -2904,7 +2917,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="overview.html" title="Overview and Tutorial"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">gvar 11.9.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">gvar 11.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">gvar</span></code> - Gaussian Random Variables</a></li>
</ul>
</div>
Expand Down
Loading

0 comments on commit 3cbf0e0

Please sign in to comment.