Skip to content

Commit

Permalink
Adds new docs with python and matlab snippets
Browse files Browse the repository at this point in the history
  • Loading branch information
StephenNneji committed Nov 11, 2024
1 parent 35c9312 commit 53907b6
Show file tree
Hide file tree
Showing 425 changed files with 489 additions and 18,778 deletions.
4 changes: 4 additions & 0 deletions dev/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +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: 5e478f088ee0a9eaa98bf0c40907626c
tags: 645f666f9bcd5a90fca523b33c5a78b7
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions master/_sources/api.rst.txt → dev/_sources/api.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -297,14 +297,14 @@ properly on terminal.
:caption: Adding MATLAB custom file.
% Row Name Custom File Name Language Path
problem.addCustomFile('DSPC Model','customBilayer.m','matlab',pwd);
problem.addCustomFile('DSPC Model','customBilayer.m','matlab','pwd');
.. code-block:: MATLAB
:caption: Adding C++ custom file.
% For C++, function name of the cpp file is supplied
% Row Name DLL/function Name Language Path
problem.addCustomFile('DSPC CPP Model','customBilayer','c++',pwd);
problem.addCustomFile('DSPC CPP Model','customBilayer','c++','pwd');
Expand Down
File renamed without changes.
7 changes: 7 additions & 0 deletions dev/_sources/bayesPlot.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _bayesPlot:


Bayesian Plotting Functions.
............................

TODO
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
7 changes: 7 additions & 0 deletions dev/_sources/conversionFuncs.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _conversionFuncs:


Convert between RAT and RasCAL1
...............................

TODO
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ properly on terminal.
:caption: Adding MATLAB custom file.
% Row Name Custom File Name Language Path
problem.addCustomFile('DSPC Model','customBilayer.m','matlab',pwd);
problem.addCustomFile('DSPC Model','customBilayer.m','matlab','pwd');
.. code-block:: MATLAB
:caption: Adding C++ custom file.
% For C++, function name of the cpp file is supplied
% Row Name DLL/function Name Language Path
problem.addCustomFile('DSPC CPP Model','customBilayer','c++',pwd);
problem.addCustomFile('DSPC CPP Model','customBilayer','c++','pwd');
.. warning::
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,4 @@ domain that the 'domainClass' is used. As with 'normal reflectivity', we can han
:maxdepth: 2

domainsStanlay
domainsCustomLayers
domainsCustomXY
domainsCustomLayers
File renamed without changes.
File renamed without changes.
File renamed without changes.
7 changes: 7 additions & 0 deletions dev/_sources/livePlot.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _livePlot:


Live Updating Plots
...................

TODO
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
7 changes: 7 additions & 0 deletions dev/_sources/simplePlot.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _simplePlotting:


Basic Plotting Functions.
.........................

TODO
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ These are mainly plotting functions:-


.. toctree::
:maxdepth: 1
:maxdepth: 2

plotFuns
plotFunsBayes
simplePlot
bayesPlot
livePlot
conversionFuncs
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.

Large diffs are not rendered by default.

27 changes: 27 additions & 0 deletions dev/_static/design-tabs.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
var sd_labels_by_text = {};

function ready() {
const li = document.getElementsByClassName("sd-tab-label");
for (const label of li) {
syncId = label.getAttribute("data-sync-id");
if (syncId) {
label.onclick = onLabelClick;
if (!sd_labels_by_text[syncId]) {
sd_labels_by_text[syncId] = [];
}
sd_labels_by_text[syncId].push(label);
}
}
}

function onLabelClick() {
// Activate other inputs with the same sync id.
syncId = this.getAttribute("data-sync-id");
for (label of sd_labels_by_text[syncId]) {
if (label === this) continue;
label.previousElementSibling.checked = true;
}
window.localStorage.setItem("sphinx-design-last-tab", syncId);
}

document.addEventListener("DOMContentLoaded", ready, false);
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions master/api.html → dev/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -402,15 +402,15 @@ <h3>Custom File Class<a class="headerlink" href="#custom-file-class" title="Perm
<div class="literal-block-wrapper docutils container" id="id14">
<div class="code-block-caption"><span class="caption-text">Adding MATLAB custom file.</span><a class="headerlink" href="#id14" title="Permalink to this code"></a></div>
<div class="highlight-MATLAB notranslate"><div class="highlight"><pre><span></span><span class="w"> </span><span class="c">% Row Name Custom File Name Language Path</span>
<span class="w"> </span><span class="n">problem</span><span class="p">.</span><span class="n">addCustomFile</span><span class="p">(</span><span class="s">&#39;DSPC Model&#39;</span><span class="p">,</span><span class="s">&#39;customBilayer.m&#39;</span><span class="p">,</span><span class="s">&#39;matlab&#39;</span><span class="p">,</span><span class="nb">pwd</span><span class="p">);</span>
<span class="w"> </span><span class="n">problem</span><span class="p">.</span><span class="n">addCustomFile</span><span class="p">(</span><span class="s">&#39;DSPC Model&#39;</span><span class="p">,</span><span class="s">&#39;customBilayer.m&#39;</span><span class="p">,</span><span class="s">&#39;matlab&#39;</span><span class="p">,</span><span class="s">&#39;pwd&#39;</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="literal-block-wrapper docutils container" id="id15">
<div class="code-block-caption"><span class="caption-text">Adding C++ custom file.</span><a class="headerlink" href="#id15" title="Permalink to this code"></a></div>
<div class="highlight-MATLAB notranslate"><div class="highlight"><pre><span></span><span class="w"> </span><span class="c">% For C++, function name of the cpp file is supplied</span>
<span class="w"> </span><span class="c">% Row Name DLL/function Name Language Path</span>
<span class="w"> </span><span class="n">problem</span><span class="p">.</span><span class="n">addCustomFile</span><span class="p">(</span><span class="s">&#39;DSPC CPP Model&#39;</span><span class="p">,</span><span class="s">&#39;customBilayer&#39;</span><span class="p">,</span><span class="s">&#39;c++&#39;</span><span class="p">,</span><span class="nb">pwd</span><span class="p">);</span>
<span class="w"> </span><span class="n">problem</span><span class="p">.</span><span class="n">addCustomFile</span><span class="p">(</span><span class="s">&#39;DSPC CPP Model&#39;</span><span class="p">,</span><span class="s">&#39;customBilayer&#39;</span><span class="p">,</span><span class="s">&#39;c++&#39;</span><span class="p">,</span><span class="s">&#39;pwd&#39;</span><span class="p">);</span>
</pre></div>
</div>
</div>
Expand Down
File renamed without changes.
113 changes: 113 additions & 0 deletions dev/bayesPlot.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>Bayesian Plotting Functions. &#8212; RAT 1.0.0-beta documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<link rel="stylesheet" type="text/css" href="_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/design-tabs.js"></script>
<link rel="icon" href="_static/logo.png"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Live Updating Plots" href="livePlot.html" />
<link rel="prev" title="Basic Plotting Functions." href="simplePlot.html" />

<link rel="stylesheet" href="_static/custom.css" type="text/css" />





</head><body>
<div class="document">

<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo">
<a href="index.html">
<img class="logo" src="_static/logo.png" alt="Logo" />

</a>
</p>









<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="algorithms.html">Algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced Topics</a></li>
<li class="toctree-l1"><a class="reference internal" href="calcTypes.html">Different Calculation Types</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="utilities.html">Utility Functions</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="simplePlot.html">Basic Plotting Functions.</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Bayesian Plotting Functions.</a></li>
<li class="toctree-l2"><a class="reference internal" href="livePlot.html">Live Updating Plots</a></li>
<li class="toctree-l2"><a class="reference internal" href="conversionFuncs.html">Convert between RAT and RasCAL1</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li>
</ul>


</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">


<div class="body" role="main">

<section id="bayesian-plotting-functions">
<span id="bayesplot"></span><h1>Bayesian Plotting Functions.<a class="headerlink" href="#bayesian-plotting-functions" title="Permalink to this heading"></a></h1>
<p>TODO</p>
</section>


</div>

</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2022-2024, ISIS Neutron and Muon Source.

|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 6.2.1</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>

|
<a href="_sources/bayesPlot.rst.txt"
rel="nofollow">Page source</a>
</div>




</body>
</html>
1 change: 0 additions & 1 deletion master/calcTypes.html → dev/calcTypes.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,6 @@ <h3 id="searchlabel">Quick search</h3>
<li class="toctree-l1"><a class="reference internal" href="incoherent.html">Incoherent Summing (Domains)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="domainsStanlay.html">Standard Layers Domains</a></li>
<li class="toctree-l2"><a class="reference internal" href="domainsCustomLayers.html">Custom Models with Domains</a></li>
<li class="toctree-l2"><a class="reference internal" href="domainsCustomXY.html">Custom XY Models with Domains</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="oilWater.html">Reflectivity from Oil/Water Samples</a></li>
Expand Down
File renamed without changes.
File renamed without changes.
12 changes: 0 additions & 12 deletions master/contrastsClass.html → dev/contrastsClass.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,12 +149,6 @@ <h2>Reference<a class="headerlink" href="#reference" title="Permalink to this he
</dl>
</dd></dl>

<dl class="mat staticmethod">
<dt class="sig sig-object mat" id="API.projectClass.contrastsClass.setDefaultValues">
<em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">setDefaultValues</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">contrast</span></em><span class="sig-paren">)</span><a class="headerlink" href="#API.projectClass.contrastsClass.setDefaultValues" title="Permalink to this definition"></a></dt>
<dd><p>Set non-empty default values when adding a contrast.</p>
</dd></dl>

<dl class="mat method">
<dt class="sig sig-object mat" id="API.projectClass.contrastsClass.toStruct">
<span class="sig-name descname"><span class="pre">toStruct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">allowedNames</span></em>, <em class="sig-param"><span class="pre">modelType</span></em>, <em class="sig-param"><span class="pre">dataTable</span></em><span class="sig-paren">)</span><a class="headerlink" href="#API.projectClass.contrastsClass.toStruct" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -193,12 +187,6 @@ <h2>Reference<a class="headerlink" href="#reference" title="Permalink to this he
<p>contrastsClass.parseContrastInput(‘name’, ‘Contrast Name’)</p>
</dd></dl>

<dl class="mat staticmethod">
<dt class="sig sig-object mat" id="API.projectClass.domainContrastsClass.setDefaultValues">
<em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">setDefaultValues</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">contrast</span></em><span class="sig-paren">)</span><a class="headerlink" href="#API.projectClass.domainContrastsClass.setDefaultValues" title="Permalink to this definition"></a></dt>
<dd><p>Set non-empty default values when adding a contrast.</p>
</dd></dl>

<dl class="mat method">
<dt class="sig sig-object mat" id="API.projectClass.domainContrastsClass.toStruct">
<span class="sig-name descname"><span class="pre">toStruct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">allowedNames</span></em>, <em class="sig-param"><span class="pre">~</span></em>, <em class="sig-param"><span class="pre">~</span></em><span class="sig-paren">)</span><a class="headerlink" href="#API.projectClass.domainContrastsClass.toStruct" title="Permalink to this definition"></a></dt>
Expand Down
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 53907b6

Please sign in to comment.