updated documentation for factor search

quanted · May 9, 2024 · 1006fc6 · 1006fc6
1 parent f93d771
commit 1006fc6
Show file tree

Hide file tree

Showing 30 changed files with 469 additions and 167 deletions.
diff --git a/docs/doctrees/docs/esat.data.doctree b/docs/doctrees/docs/esat.data.doctree
diff --git a/docs/doctrees/docs/esat.doctree b/docs/doctrees/docs/esat.doctree
diff --git a/docs/doctrees/docs/esat.model.doctree b/docs/doctrees/docs/esat.model.doctree
diff --git a/docs/doctrees/docs/eval.doctree b/docs/doctrees/docs/eval.doctree
diff --git a/docs/doctrees/docs/modules.doctree b/docs/doctrees/docs/modules.doctree
diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
diff --git a/docs/esat.rst b/docs/esat.rst
@@ -40,6 +40,14 @@ esat.utils module
    :undoc-members:
    :show-inheritance:
 
+esat.helpers module
+-------------------
+
+.. automodule:: esat.helpers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------
 

diff --git a/docs/html/.buildinfo b/docs/html/.buildinfo
@@ -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: 4ba35afb90c5b2d0b85054e11078cc3e
+config: e003a3c28bc7bdc3940c6564486661b4
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/html/README.html b/docs/html/README.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Environmental Source Apportionment Toolkit (ESAT) &mdash; Environmental Source Apportionment Toolkit (ESAT) 04/23/2024 documentation</title>
+  <title>Environmental Source Apportionment Toolkit (ESAT) &mdash; Environmental Source Apportionment Toolkit (ESAT) 05/09/2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=2ceadbe7"></script>
+        <script src="_static/documentation_options.js?v=b5dd6643"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

diff --git a/docs/html/_sources/docs/esat.rst.txt b/docs/html/_sources/docs/esat.rst.txt
@@ -40,6 +40,14 @@ esat.utils module
    :undoc-members:
    :show-inheritance:
 
+esat.helpers module
+-------------------
+
+.. automodule:: esat.helpers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------
 

diff --git a/docs/html/_sources/docs/modules.rst.txt b/docs/html/_sources/docs/modules.rst.txt
@@ -2,10 +2,11 @@ Python API
 ===============
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
+   esat.rst
    esat.data.rst
    esat.error.rst
    esat.model.rst
    esat.rotational.rst
-   eval.rst
+   eval.rst
diff --git a/docs/html/_static/documentation_options.js b/docs/html/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '04/23/2024',
+    VERSION: '05/09/2024',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/html/docs/cli.html b/docs/html/docs/cli.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Command Line Interface &mdash; Environmental Source Apportionment Toolkit (ESAT) 04/23/2024 documentation</title>
+  <title>Command Line Interface &mdash; Environmental Source Apportionment Toolkit (ESAT) 05/09/2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../_static/documentation_options.js?v=2ceadbe7"></script>
+        <script src="../_static/documentation_options.js?v=b5dd6643"></script>
         <script src="../_static/doctools.js?v=9a2dae69"></script>
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>

diff --git a/docs/html/docs/esat.cli.html b/docs/html/docs/esat.cli.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>esat.cli package &mdash; Environmental Source Apportionment Toolkit (ESAT) 04/23/2024 documentation</title>
+  <title>esat.cli package &mdash; Environmental Source Apportionment Toolkit (ESAT) 05/09/2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../_static/documentation_options.js?v=2ceadbe7"></script>
+        <script src="../_static/documentation_options.js?v=b5dd6643"></script>
         <script src="../_static/doctools.js?v=9a2dae69"></script>
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>

diff --git a/docs/html/docs/esat.data.html b/docs/html/docs/esat.data.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>esat.data package &mdash; Environmental Source Apportionment Toolkit (ESAT) 04/23/2024 documentation</title>
+  <title>esat.data package &mdash; Environmental Source Apportionment Toolkit (ESAT) 05/09/2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../_static/documentation_options.js?v=2ceadbe7"></script>
+        <script src="../_static/documentation_options.js?v=b5dd6643"></script>
         <script src="../_static/doctools.js?v=9a2dae69"></script>
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>
@@ -110,7 +110,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <span id="esat-data-analysis-module"></span><h2>esat.data.analysis module<a class="headerlink" href="#module-esat.data.analysis" title="Link to this heading"></a></h2>
 <dl class="py class">
 <dt class="sig sig-object py" id="esat.data.analysis.BatchAnalysis">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">esat.data.analysis.</span></span><span class="sig-name descname"><span class="pre">BatchAnalysis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">batch_sa</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="esat.model.html#esat.model.batch_sa.BatchSA" title="esat.model.batch_sa.BatchSA"><span class="pre">BatchSA</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#esat.data.analysis.BatchAnalysis" title="Link to this definition"></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">esat.data.analysis.</span></span><span class="sig-name descname"><span class="pre">BatchAnalysis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">batch_sa</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="esat.model.html#esat.model.batch_sa.BatchSA" title="esat.model.batch_sa.BatchSA"><span class="pre">BatchSA</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_handler</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#esat.data.datahandler.DataHandler" title="esat.data.datahandler.DataHandler"><span class="pre">DataHandler</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#esat.data.analysis.BatchAnalysis" title="Link to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <p>Class for running batch solution analysis.</p>
 <dl class="field-list simple">
@@ -137,6 +137,17 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 behavior. In this case, reducing the number of factors can resolve overfitting the model.</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="esat.data.analysis.BatchAnalysis.plot_temporal_residuals">
+<span class="sig-name descname"><span class="pre">plot_temporal_residuals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feature_idx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#esat.data.analysis.BatchAnalysis.plot_temporal_residuals" title="Link to this definition"></a></dt>
+<dd><p>Plot the temporal residuals for a specified feature, by index, of all models in the SA batch.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>feature_idx</strong> (<em>int</em>) – The index of the feature to plot.</p>
+</dd>
+</dl>
+</dd></dl>
+
 </dd></dl>
 
 <dl class="py class">

diff --git a/docs/html/docs/esat.error.html b/docs/html/docs/esat.error.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>esat.error package &mdash; Environmental Source Apportionment Toolkit (ESAT) 04/23/2024 documentation</title>
+  <title>esat.error package &mdash; Environmental Source Apportionment Toolkit (ESAT) 05/09/2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../_static/documentation_options.js?v=2ceadbe7"></script>
+        <script src="../_static/documentation_options.js?v=b5dd6643"></script>
         <script src="../_static/doctools.js?v=9a2dae69"></script>
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>