update docs

Author: Bultako

docs/_build/html/.doctrees/api/mutis.correlation.Correlation.doctree

@@ -37,6 +37,7 @@
         <script src="../_static/jquery.js"></script>
         <script src="../_static/underscore.js"></script>
         <script src="../_static/doctools.js"></script>
+        <script src="../_static/copybutton.js"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
 
     <script type="text/javascript" src="../_static/js/theme.js"></script>
@@ -164,9 +165,9 @@
 
   <h1>All modules for which code is available</h1>
 <ul><li><a href="mutis/correlation/core.html">mutis.correlation.core</a></li>
-<li><a href="mutis/correlation/methods.html">mutis.correlation.methods</a></li>
+<li><a href="mutis/correlation/functions.html">mutis.correlation.functions</a></li>
 <li><a href="mutis/signal/core.html">mutis.signal.core</a></li>
-<li><a href="mutis/signal/methods.html">mutis.signal.methods</a></li>
+<li><a href="mutis/signal/functions.html">mutis.signal.functions</a></li>
 </ul>
 
            </div>

docs/_build/html/.doctrees/api/mutis.correlation.gen_times_canopy.doctree

@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>mutis.signal.methods &mdash; MUTIS  documentation</title>
+  <title>mutis.signal.functions &mdash; MUTIS  documentation</title>
 
 
 
@@ -37,6 +37,7 @@
         <script src="../../../_static/jquery.js"></script>
         <script src="../../../_static/underscore.js"></script>
         <script src="../../../_static/doctools.js"></script>
+        <script src="../../../_static/copybutton.js"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
 
     <script type="text/javascript" src="../../../_static/js/theme.js"></script>
@@ -149,7 +150,7 @@
 
           <li><a href="../../index.html">Module code</a> &raquo;</li>
 
-      <li>mutis.signal.methods</li>
+      <li>mutis.signal.functions</li>
 
 
       <li class="wy-breadcrumbs-aside">
@@ -164,15 +165,15 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <h1>Source code for mutis.signal.methods</h1><div class="highlight"><pre>
+  <h1>Source code for mutis.signal.functions</h1><div class="highlight"><pre>
 <span></span><span class="c1"># Licensed under a 3-clause BSD style license - see LICENSE</span>
 <span class="sd">&quot;&quot;&quot;Methods for synthetic generation of light curves.&quot;&quot;&quot;</span>
 
 <span class="kn">import</span> <span class="nn">logging</span>
 
+<span class="kn">import</span> <span class="nn">nfft</span>
 <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
 <span class="kn">import</span> <span class="nn">scipy.signal</span> <span class="k">as</span> <span class="nn">scipy_signal</span>
-<span class="kn">import</span> <span class="nn">nfft</span>
 
 <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
     <span class="s2">&quot;lc_gen_samp&quot;</span><span class="p">,</span>
@@ -255,6 +256,8 @@ <h1>Source code for mutis.signal.methods</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="lc_gen_psd_lombscargle"><a class="viewcode-back" href="../../../api/mutis.signal.lc_gen_psd_lombscargle.html#mutis.signal.lc_gen_psd_lombscargle">[docs]</a><span class="k">def</span> <span class="nf">lc_gen_psd_lombscargle</span><span class="p">(</span><span class="n">times</span><span class="p">,</span> <span class="n">signs</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;Description goes here.&quot;&quot;&quot;</span>
+
     <span class="k">if</span> <span class="n">signs</span><span class="o">.</span><span class="n">size</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
         <span class="n">sigp</span> <span class="o">=</span> <span class="n">signs</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
         <span class="n">tp</span> <span class="o">=</span> <span class="n">times</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
@@ -276,7 +279,7 @@ <h1>Source code for mutis.signal.methods</h1><div class="highlight"><pre>
     <span class="n">s2</span> <span class="o">=</span> <span class="n">nfft</span><span class="o">.</span><span class="n">nfft</span><span class="p">((</span><span class="n">times</span> <span class="o">-</span> <span class="p">(</span><span class="n">times</span><span class="o">.</span><span class="n">max</span><span class="p">()</span> <span class="o">+</span> <span class="n">times</span><span class="o">.</span><span class="n">min</span><span class="p">())</span> <span class="o">/</span> <span class="mi">2</span><span class="p">)</span> <span class="o">/</span> <span class="n">np</span><span class="o">.</span><span class="n">ptp</span><span class="p">(</span><span class="n">times</span><span class="p">),</span> <span class="n">fft2</span><span class="p">,</span> <span class="n">N</span><span class="p">,</span> <span class="n">use_fft</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="o">/</span> <span class="n">N</span>
 
     <span class="c1"># fix small deviations</span>
-    <span class="n">a</span> <span class="o">=</span> <span class="p">(</span><span class="n">signs</span><span class="o">.</span><span class="n">std</span><span class="p">()</span> <span class="o">/</span> <span class="n">s2</span><span class="o">.</span><span class="n">std</span><span class="p">())</span>
+    <span class="n">a</span> <span class="o">=</span> <span class="n">signs</span><span class="o">.</span><span class="n">std</span><span class="p">()</span> <span class="o">/</span> <span class="n">s2</span><span class="o">.</span><span class="n">std</span><span class="p">()</span>
     <span class="n">b</span> <span class="o">=</span> <span class="n">signs</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span> <span class="o">-</span> <span class="n">a</span> <span class="o">*</span> <span class="n">s2</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span>
     <span class="n">s2</span> <span class="o">=</span> <span class="n">a</span> <span class="o">*</span> <span class="n">s2</span> <span class="o">+</span> <span class="n">b</span>
 
@@ -289,7 +292,7 @@ <h1>Source code for mutis.signal.methods</h1><div class="highlight"><pre>
 
     <span class="n">nft</span> <span class="o">=</span> <span class="n">nfft</span><span class="o">.</span><span class="n">nfft_adjoint</span><span class="p">((</span><span class="n">times</span> <span class="o">-</span> <span class="p">(</span><span class="n">times</span><span class="o">.</span><span class="n">max</span><span class="p">()</span> <span class="o">+</span> <span class="n">times</span><span class="o">.</span><span class="n">min</span><span class="p">())</span> <span class="o">/</span> <span class="mi">2</span><span class="p">)</span> <span class="o">/</span> <span class="n">np</span><span class="o">.</span><span class="n">ptp</span><span class="p">(</span><span class="n">times</span><span class="p">),</span> <span class="n">signs</span><span class="p">,</span> <span class="n">N</span><span class="p">,</span> <span class="n">use_fft</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 
-    <span class="c1"># build random phase to get real signal:</span>
+    <span class="c1"># build random phase to get real signal</span>
     <span class="n">phase</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">random</span><span class="p">(</span><span class="n">N</span> <span class="o">//</span> <span class="mi">2</span><span class="p">)</span>
     <span class="n">phase</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">concatenate</span><span class="p">((</span><span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">flip</span><span class="p">(</span><span class="n">phase</span><span class="p">),</span> <span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">phase</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]))</span>
 
@@ -298,7 +301,7 @@ <h1>Source code for mutis.signal.methods</h1><div class="highlight"><pre>
     <span class="n">s2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">real</span><span class="p">(</span><span class="n">s2</span><span class="p">)</span>  <span class="c1"># np.real to fix small imaginary part from numerical error</span>
 
     <span class="c1"># fix small mean, std difference from numerical error</span>
-    <span class="n">a</span> <span class="o">=</span> <span class="p">(</span><span class="n">signs</span><span class="o">.</span><span class="n">std</span><span class="p">()</span> <span class="o">/</span> <span class="n">s2</span><span class="o">.</span><span class="n">std</span><span class="p">())</span>
+    <span class="n">a</span> <span class="o">=</span> <span class="n">signs</span><span class="o">.</span><span class="n">std</span><span class="p">()</span> <span class="o">/</span> <span class="n">s2</span><span class="o">.</span><span class="n">std</span><span class="p">()</span>
     <span class="n">b</span> <span class="o">=</span> <span class="n">signs</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span> <span class="o">-</span> <span class="n">a</span> <span class="o">*</span> <span class="n">s2</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span>
     <span class="n">s2</span> <span class="o">=</span> <span class="n">a</span> <span class="o">*</span> <span class="n">s2</span> <span class="o">+</span> <span class="n">b</span>