deploy: a58fd20

CosmoStat · Nov 7, 2023 · 2bd0af6 · 2bd0af6
1 parent c4de346
commit 2bd0af6
Show file tree

Hide file tree

Showing 14 changed files with 11 additions and 459 deletions.
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/wf_psf.plotting.doctree b/.doctrees/wf_psf.plotting.doctree
diff --git a/.doctrees/wf_psf.plotting.plot_optimisation_metrics.doctree b/.doctrees/wf_psf.plotting.plot_optimisation_metrics.doctree
diff --git a/_modules/index.html b/_modules/index.html
@@ -94,7 +94,6 @@ <h1>All modules for which code is available</h1>
 <ul><li><a href="wf_psf/data/training_preprocessing.html">wf_psf.data.training_preprocessing</a></li>
 <li><a href="wf_psf/metrics/metrics.html">wf_psf.metrics.metrics</a></li>
 <li><a href="wf_psf/metrics/metrics_interface.html">wf_psf.metrics.metrics_interface</a></li>
-<li><a href="wf_psf/plotting/plot_optimisation_metrics.html">wf_psf.plotting.plot_optimisation_metrics</a></li>
 <li><a href="wf_psf/plotting/plots_interface.html">wf_psf.plotting.plots_interface</a></li>
 <li><a href="wf_psf/psf_models/psf_model_parametric.html">wf_psf.psf_models.psf_model_parametric</a></li>
 <li><a href="wf_psf/psf_models/psf_model_semiparametric.html">wf_psf.psf_models.psf_model_semiparametric</a></li>

diff --git a/_modules/wf_psf/plotting/plot_optimisation_metrics.html b/_modules/wf_psf/plotting/plot_optimisation_metrics.html
diff --git a/_sources/wf_psf.plotting.rst.txt b/_sources/wf_psf.plotting.rst.txt
@@ -12,5 +12,4 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
-   wf_psf.plotting.plot_optimisation_metrics
    wf_psf.plotting.plots_interface
diff --git a/genindex.html b/genindex.html
@@ -528,8 +528,6 @@ <h2 id="M">M</h2>
         <li><a href="wf_psf.metrics.metrics_interface.html#module-wf_psf.metrics.metrics_interface">wf_psf.metrics.metrics_interface</a>
 </li>
         <li><a href="wf_psf.plotting.html#module-wf_psf.plotting">wf_psf.plotting</a>
-</li>
-        <li><a href="wf_psf.plotting.plot_optimisation_metrics.html#module-wf_psf.plotting.plot_optimisation_metrics">wf_psf.plotting.plot_optimisation_metrics</a>
 </li>
         <li><a href="wf_psf.plotting.plots_interface.html#module-wf_psf.plotting.plots_interface">wf_psf.plotting.plots_interface</a>
 </li>
@@ -643,8 +641,6 @@ <h2 id="P">P</h2>
       <li><a href="wf_psf.plotting.plots_interface.html#wf_psf.plotting.plots_interface.plot_metrics">plot_metrics() (in module wf_psf.plotting.plots_interface)</a>
 </li>
       <li><a href="wf_psf.sims.SimPSFToolkit.html#wf_psf.sims.SimPSFToolkit.SimPSFToolkit.plot_opd_phase">plot_opd_phase() (wf_psf.sims.SimPSFToolkit.SimPSFToolkit method)</a>
-</li>
-      <li><a href="wf_psf.plotting.plot_optimisation_metrics.html#wf_psf.plotting.plot_optimisation_metrics.plot_optimisation_metrics">plot_optimisation_metrics() (in module wf_psf.plotting.plot_optimisation_metrics)</a>
 </li>
       <li><a href="wf_psf.sims.SimPSFToolkit.html#wf_psf.sims.SimPSFToolkit.SimPSFToolkit.plot_psf">plot_psf() (wf_psf.sims.SimPSFToolkit.SimPSFToolkit method)</a>
 </li>
@@ -967,13 +963,6 @@ <h2 id="W">W</h2>
 
       <ul>
         <li><a href="wf_psf.plotting.html#module-wf_psf.plotting">module</a>
-</li>
-      </ul></li>
-      <li>
-    wf_psf.plotting.plot_optimisation_metrics
-
-      <ul>
-        <li><a href="wf_psf.plotting.plot_optimisation_metrics.html#module-wf_psf.plotting.plot_optimisation_metrics">module</a>
 </li>
       </ul></li>
       <li>

diff --git a/objects.inv b/objects.inv
diff --git a/py-modindex.html b/py-modindex.html
@@ -140,11 +140,6 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="wf_psf.plotting.html#module-wf_psf.plotting"><code class="xref">wf_psf.plotting</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-1">
-       <td></td>
-       <td>&#160;&#160;&#160;
-       <a href="wf_psf.plotting.plot_optimisation_metrics.html#module-wf_psf.plotting.plot_optimisation_metrics"><code class="xref">wf_psf.plotting.plot_optimisation_metrics</code></a></td><td>
-       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;

diff --git a/searchindex.js b/searchindex.js
diff --git a/wf_psf.html b/wf_psf.html
@@ -151,10 +151,6 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 </li>
 <li class="toctree-l1"><a class="reference internal" href="wf_psf.plotting.html">wf_psf.plotting package</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="wf_psf.plotting.html#submodules">Submodules</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="wf_psf.plotting.plot_optimisation_metrics.html">wf_psf.plotting.plot_optimisation_metrics module</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="wf_psf.plotting.plot_optimisation_metrics.html#wf_psf.plotting.plot_optimisation_metrics.plot_optimisation_metrics"><code class="docutils literal notranslate"><span class="pre">plot_optimisation_metrics()</span></code></a></li>
-</ul>
-</li>
 <li class="toctree-l3"><a class="reference internal" href="wf_psf.plotting.plots_interface.html">wf_psf.plotting.plots_interface module</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="wf_psf.plotting.plots_interface.html#wf_psf.plotting.plots_interface.MetricsPlotHandler"><code class="docutils literal notranslate"><span class="pre">MetricsPlotHandler</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="wf_psf.plotting.plots_interface.html#wf_psf.plotting.plots_interface.MonochromaticMetricsPlotHandler"><code class="docutils literal notranslate"><span class="pre">MonochromaticMetricsPlotHandler</span></code></a></li>

diff --git a/wf_psf.plotting.html b/wf_psf.plotting.html
@@ -23,7 +23,7 @@
     <link rel="author" title="About these documents" href="about.html" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="wf_psf.plotting.plot_optimisation_metrics module" href="wf_psf.plotting.plot_optimisation_metrics.html" />
+    <link rel="next" title="wf_psf.plotting.plots_interface module" href="wf_psf.plotting.plots_interface.html" />
     <link rel="prev" title="wf_psf.metrics.metrics_interface module" href="wf_psf.metrics.metrics_interface.html" /> 
 </head>
 
@@ -67,7 +67,6 @@
 <li class="toctree-l2"><a class="reference internal" href="wf_psf.data.html">wf_psf.data package</a></li>
 <li class="toctree-l2"><a class="reference internal" href="wf_psf.metrics.html">wf_psf.metrics package</a></li>
 <li class="toctree-l2 current"><a class="current reference internal" href="#">wf_psf.plotting package</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="wf_psf.plotting.plot_optimisation_metrics.html">wf_psf.plotting.plot_optimisation_metrics module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="wf_psf.plotting.plots_interface.html">wf_psf.plotting.plots_interface module</a></li>
 </ul>
 </li>
@@ -115,10 +114,6 @@
 <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading"></a></h2>
 <div class="toctree-wrapper compound">
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="wf_psf.plotting.plot_optimisation_metrics.html">wf_psf.plotting.plot_optimisation_metrics module</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="wf_psf.plotting.plot_optimisation_metrics.html#wf_psf.plotting.plot_optimisation_metrics.plot_optimisation_metrics"><code class="docutils literal notranslate"><span class="pre">plot_optimisation_metrics()</span></code></a></li>
-</ul>
-</li>
 <li class="toctree-l1"><a class="reference internal" href="wf_psf.plotting.plots_interface.html">wf_psf.plotting.plots_interface module</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="wf_psf.plotting.plots_interface.html#wf_psf.plotting.plots_interface.MetricsPlotHandler"><code class="docutils literal notranslate"><span class="pre">MetricsPlotHandler</span></code></a><ul>
 <li class="toctree-l3"><a class="reference internal" href="wf_psf.plotting.plots_interface.html#wf_psf.plotting.plots_interface.MetricsPlotHandler.get_metrics"><code class="docutils literal notranslate"><span class="pre">MetricsPlotHandler.get_metrics()</span></code></a></li>
@@ -152,7 +147,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="wf_psf.metrics.metrics_interface.html" class="btn btn-neutral float-left" title="wf_psf.metrics.metrics_interface module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="wf_psf.plotting.plot_optimisation_metrics.html" class="btn btn-neutral float-right" title="wf_psf.plotting.plot_optimisation_metrics module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="wf_psf.plotting.plots_interface.html" class="btn btn-neutral float-right" title="wf_psf.plotting.plots_interface module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

diff --git a/wf_psf.plotting.plot_optimisation_metrics.html b/wf_psf.plotting.plot_optimisation_metrics.html
@@ -22,9 +22,7 @@
     <script src="_static/js/theme.js"></script>
     <link rel="author" title="About these documents" href="about.html" />
     <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="wf_psf.plotting.plots_interface module" href="wf_psf.plotting.plots_interface.html" />
-    <link rel="prev" title="wf_psf.plotting package" href="wf_psf.plotting.html" /> 
+    <link rel="search" title="Search" href="search.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -62,22 +60,8 @@
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
-<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="wf_psf.html">wf_psf package</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="wf_psf.data.html">wf_psf.data package</a></li>
-<li class="toctree-l2"><a class="reference internal" href="wf_psf.metrics.html">wf_psf.metrics package</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="wf_psf.plotting.html">wf_psf.plotting package</a><ul class="current">
-<li class="toctree-l3 current"><a class="current reference internal" href="#">wf_psf.plotting.plot_optimisation_metrics module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="wf_psf.plotting.plots_interface.html">wf_psf.plotting.plots_interface module</a></li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="wf_psf.psf_models.html">wf_psf.psf_models package</a></li>
-<li class="toctree-l2"><a class="reference internal" href="wf_psf.sims.html">wf_psf.sims package</a></li>
-<li class="toctree-l2"><a class="reference internal" href="wf_psf.training.html">wf_psf.training package</a></li>
-<li class="toctree-l2"><a class="reference internal" href="wf_psf.utils.html">wf_psf.utils package</a></li>
-<li class="toctree-l2"><a class="reference internal" href="wf_psf.run.html">wf_psf.run module</a></li>
-</ul>
-</li>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="wf_psf.html">wf_psf package</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">References</span></p>
 <ul>
@@ -98,8 +82,6 @@
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
       <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
-          <li class="breadcrumb-item"><a href="wf_psf.html">wf_psf package</a></li>
-          <li class="breadcrumb-item"><a href="wf_psf.plotting.html">wf_psf.plotting package</a></li>
       <li class="breadcrumb-item active">wf_psf.plotting.plot_optimisation_metrics module</li>
       <li class="wy-breadcrumbs-aside">
             <a href="_sources/wf_psf.plotting.plot_optimisation_metrics.rst.txt" rel="nofollow"> View page source</a>
@@ -110,31 +92,14 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="module-wf_psf.plotting.plot_optimisation_metrics">
-<span id="wf-psf-plotting-plot-optimisation-metrics-module"></span><h1>wf_psf.plotting.plot_optimisation_metrics module<a class="headerlink" href="#module-wf_psf.plotting.plot_optimisation_metrics" title="Link to this heading"></a></h1>
-<p>Plot Optimisation Metrics.</p>
-<p>A module to produce plots of the various
-PSF optimation metrics.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Author<span class="colon">:</span></dt>
-<dd class="field-odd"><p>Jennifer Pollack &lt;<a class="reference external" href="mailto:jennifer&#46;pollack&#37;&#52;&#48;cea&#46;fr">jennifer<span>&#46;</span>pollack<span>&#64;</span>cea<span>&#46;</span>fr</a>&gt;</p>
-</dd>
-</dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="wf_psf.plotting.plot_optimisation_metrics.plot_optimisation_metrics">
-<span class="sig-prename descclassname"><span class="pre">wf_psf.plotting.plot_optimisation_metrics.</span></span><span class="sig-name descname"><span class="pre">plot_optimisation_metrics</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/wf_psf/plotting/plot_optimisation_metrics.html#plot_optimisation_metrics"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wf_psf.plotting.plot_optimisation_metrics.plot_optimisation_metrics" title="Link to this definition"></a></dt>
-<dd><p>Plot optimisation results.</p>
-</dd></dl>
-
+  <section id="wf-psf-plotting-plot-optimisation-metrics-module">
+<h1>wf_psf.plotting.plot_optimisation_metrics module<a class="headerlink" href="#wf-psf-plotting-plot-optimisation-metrics-module" title="Link to this heading"></a></h1>
 </section>
 
 
            </div>
           </div>
-          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="wf_psf.plotting.html" class="btn btn-neutral float-left" title="wf_psf.plotting package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="wf_psf.plotting.plots_interface.html" class="btn btn-neutral float-right" title="wf_psf.plotting.plots_interface module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
-    </div>
+          <footer>
 
   <hr/>
 

diff --git a/wf_psf.plotting.plots_interface.html b/wf_psf.plotting.plots_interface.html
@@ -24,7 +24,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="wf_psf.psf_models package" href="wf_psf.psf_models.html" />
-    <link rel="prev" title="wf_psf.plotting.plot_optimisation_metrics module" href="wf_psf.plotting.plot_optimisation_metrics.html" /> 
+    <link rel="prev" title="wf_psf.plotting package" href="wf_psf.plotting.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -67,7 +67,6 @@
 <li class="toctree-l2"><a class="reference internal" href="wf_psf.data.html">wf_psf.data package</a></li>
 <li class="toctree-l2"><a class="reference internal" href="wf_psf.metrics.html">wf_psf.metrics package</a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="wf_psf.plotting.html">wf_psf.plotting package</a><ul class="current">
-<li class="toctree-l3"><a class="reference internal" href="wf_psf.plotting.plot_optimisation_metrics.html">wf_psf.plotting.plot_optimisation_metrics module</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">wf_psf.plotting.plots_interface module</a></li>
 </ul>
 </li>
@@ -336,7 +335,7 @@
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="wf_psf.plotting.plot_optimisation_metrics.html" class="btn btn-neutral float-left" title="wf_psf.plotting.plot_optimisation_metrics module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="wf_psf.plotting.html" class="btn btn-neutral float-left" title="wf_psf.plotting package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="wf_psf.psf_models.html" class="btn btn-neutral float-right" title="wf_psf.psf_models package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>