Deploying to gh-pages from @ a2ef539 🚀

MattWillFlood · Mar 30, 2024 · 0c1c487 · 0c1c487
1 parent 6019f63
commit 0c1c487
Show file tree

Hide file tree

Showing 41 changed files with 94 additions and 87 deletions.
diff --git a/Home.html b/Home.html
@@ -124,8 +124,8 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="julia/EHjulia.html">EntropyHub - Julia</a><ul>
-<li class="toctree-l2"><a class="reference external" href="https://docs.juliahub.com/EntropyHub/npy5E/0.2.0/">EntropyHub.jl</a></li>
-<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/Examples/Examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/">EntropyHub.jl</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/Examples/Examples">Examples</a></li>
 </ul>
 </li>
 </ul>
@@ -164,7 +164,7 @@ <h2>An open-source toolkit for entropic data analysis<a class="headerlink" href=
 <a class="reference internal image-reference" href="_images/EntropyHub_Profiler.png"><img alt="_images/EntropyHub_Profiler.png" class="align-center" src="_images/EntropyHub_Profiler.png" style="width: 150px; height: 150px;" /></a>
 <p class="centered">
 <strong>Available in:</strong></p><p class="centered">
-<strong><a class="reference external" href="https://www.mathworks.com/matlabcentral/fileexchange/94185-entropyhub">Matlab</a> // <a class="reference external" href="https://pypi.org/project/EntropyHub/">Python</a>  // <a class="reference external" href="https://juliahub.com/ui/Packages/EntropyHub/npy5E/">Julia</a></strong></p><div class="toctree-wrapper compound">
+<strong><a class="reference external" href="https://www.mathworks.com/matlabcentral/fileexchange/94185-entropyhub">Matlab</a> // <a class="reference external" href="https://pypi.org/project/EntropyHub/">Python</a>  // <a href="#id1"><span class="problematic" id="id2">`Julia &lt;https://mattwillflood.github.io/EntropyHub.jl/stable/`_</span></a></strong></p><div class="toctree-wrapper compound">
 </div>
 <ul class="simple">
 <li><p><a class="reference external" href="./EHupdates.html">Latest Updates</a></p></li>

diff --git a/_downloads/40d9c1910993d9509e60865d940bb066/EntropyHubGuide.pdf b/_downloads/40d9c1910993d9509e60865d940bb066/EntropyHubGuide.pdf
diff --git a/_sources/Home.rst.txt b/_sources/Home.rst.txt
@@ -18,7 +18,7 @@ An open-source toolkit for entropic data analysis
     :height: 150px
 
 .. centered:: Available in: 
-.. centered:: `Matlab  <https://www.mathworks.com/matlabcentral/fileexchange/94185-entropyhub>`_ // `Python <https://pypi.org/project/EntropyHub/>`_  // `Julia <https://juliahub.com/ui/Packages/EntropyHub/npy5E/>`_
+.. centered:: `Matlab  <https://www.mathworks.com/matlabcentral/fileexchange/94185-entropyhub>`_ // `Python <https://pypi.org/project/EntropyHub/>`_  // `Julia <https://mattwillflood.github.io/EntropyHub.jl/stable/`_
 
 .. toctree::
    :maxdepth: 3

diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -18,7 +18,7 @@ An open-source toolkit for entropic data analysis
     :height: 150px
 
 .. centered:: Available in: 
-.. centered:: `Matlab  <https://www.mathworks.com/matlabcentral/fileexchange/94185-entropyhub>`_ // `Python <https://pypi.org/project/EntropyHub/>`_  // `Julia <https://juliahub.com/ui/Packages/EntropyHub/npy5E/>`_
+.. centered:: `Matlab  <https://www.mathworks.com/matlabcentral/fileexchange/94185-entropyhub>`_ // `Python <https://pypi.org/project/EntropyHub/>`_  // `Julia <https://mattwillflood.github.io/EntropyHub.jl/stable/>`_
 
 .. toctree::
    :maxdepth: 3

diff --git a/_sources/julia/EHjulia.rst.txt b/_sources/julia/EHjulia.rst.txt
@@ -5,22 +5,22 @@ EntropyHub: Julia
 .. centered:: Links to installation files: `GitHub <https://github.com/MattWillFlood/EntropyHub.jl>`_ || `Julia Registry <https://juliahub.com/ui/Packages/EntropyHub/npy5E/>`_
 
 `EntropyHub.jl <https://juliahub.com/ui/Packages/EntropyHub/npy5E/>`_ is the EntropyHub package for *Julia*.
-The complete documentation for `EntropyHub.jl can be found here <https://docs.juliahub.com/EntropyHub/npy5E/0.2.0/>`_
+The complete documentation for `EntropyHub.jl can be found here <https://mattwillflood.github.io/EntropyHub.jl/stable/>`_
 
 .. image:: ../_images/EntropyHubJuliaLogo.png
     :width: 250px
     :align: center
     :height: 350px
-    :target: https://mattwillflood.github.io/EntropyHub.jl/
+    :target: https://mattwillflood.github.io/EntropyHub.jl/stable/
 
 
 .. toctree::
    :maxdepth: 3
    :hidden:
    :titlesonly:
 
-   EntropyHub.jl  <https://docs.juliahub.com/EntropyHub/npy5E/0.2.0/>
-   Examples <https://mattwillflood.github.io/EntropyHub.jl/Examples/Examples>
+   EntropyHub.jl  <https://mattwillflood.github.io/EntropyHub.jl/stable/>
+   Examples <https://mattwillflood.github.io/EntropyHub.jl/stable/Examples/Examples>
 
 
 Requirements & Installation:
@@ -141,4 +141,4 @@ For example:
 All information on the EntropyHub package is detailed in the *EntropyHub Guide*,
 a .pdf document available to :download:`download here <../_static/EntropyHubGuide.pdf>`.
 
-The EntropyHub Julia API can be found at https://MattWillFlood.github.io/EntropyHub.jl/.
+The EntropyHub Julia API can be found at https://MattWillFlood.github.io/EntropyHub.jl/stable/.
diff --git a/_sources/julia/jlexamples.rst.txt b/_sources/julia/jlexamples.rst.txt
@@ -4,11 +4,12 @@ EntropyHub: Julia
 
 **EntropyHub.jl** is the EntropyHub package for *Julia*.
 
-Examples in the Julia language can be found `here <https://docs.juliahub.com/General/EntropyHub/stable/Examples/Examples/>`_
+Examples in the Julia language can be found `here <https://mattwillflood.github.io/EntropyHub.jl/stable/Examples/Examples/>
+>`_
 
 .. image:: ../_images/EntropyHubJuliaLogo.png
     :width: 250px
     :align: center
     :height: 350px
-    :target: https://mattwillflood.github.io/EntropyHub.jl/dev/Examples/Examples/
+    :target: https://mattwillflood.github.io/EntropyHub.jl/stable/Examples/Examples/
 
diff --git a/_static/EntropyHubGuide.pdf b/_static/EntropyHubGuide.pdf
diff --git a/genindex.html b/genindex.html
@@ -121,8 +121,8 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="julia/EHjulia.html">EntropyHub - Julia</a><ul>
-<li class="toctree-l2"><a class="reference external" href="https://docs.juliahub.com/EntropyHub/npy5E/0.2.0/">EntropyHub.jl</a></li>
-<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/Examples/Examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/">EntropyHub.jl</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/Examples/Examples">Examples</a></li>
 </ul>
 </li>
 </ul>

diff --git a/index.html b/index.html
@@ -123,8 +123,8 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="julia/EHjulia.html">EntropyHub - Julia</a><ul>
-<li class="toctree-l2"><a class="reference external" href="https://docs.juliahub.com/EntropyHub/npy5E/0.2.0/">EntropyHub.jl</a></li>
-<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/Examples/Examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/">EntropyHub.jl</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/Examples/Examples">Examples</a></li>
 </ul>
 </li>
 </ul>
@@ -163,7 +163,7 @@ <h2>An open-source toolkit for entropic data analysis<a class="headerlink" href=
 <a class="reference internal image-reference" href="_images/EntropyHub_Profiler.png"><img alt="_images/EntropyHub_Profiler.png" class="align-center" src="_images/EntropyHub_Profiler.png" style="width: 150px; height: 150px;" /></a>
 <p class="centered">
 <strong>Available in:</strong></p><p class="centered">
-<strong><a class="reference external" href="https://www.mathworks.com/matlabcentral/fileexchange/94185-entropyhub">Matlab</a> // <a class="reference external" href="https://pypi.org/project/EntropyHub/">Python</a>  // <a class="reference external" href="https://juliahub.com/ui/Packages/EntropyHub/npy5E/">Julia</a></strong></p><div class="toctree-wrapper compound">
+<strong><a class="reference external" href="https://www.mathworks.com/matlabcentral/fileexchange/94185-entropyhub">Matlab</a> // <a class="reference external" href="https://pypi.org/project/EntropyHub/">Python</a>  // <a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/">Julia</a></strong></p><div class="toctree-wrapper compound">
 </div>
 <ul class="simple">
 <li><p><a class="reference external" href="./EHupdates.html">Latest Updates</a></p></li>

diff --git a/julia/EHjulia.html b/julia/EHjulia.html
@@ -123,8 +123,8 @@
 </ul>
 </li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">EntropyHub - Julia</a><ul>
-<li class="toctree-l2"><a class="reference external" href="https://docs.juliahub.com/EntropyHub/npy5E/0.2.0/">EntropyHub.jl</a></li>
-<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/Examples/Examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/">EntropyHub.jl</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/Examples/Examples">Examples</a></li>
 </ul>
 </li>
 </ul>
@@ -157,8 +157,8 @@
 <h1>EntropyHub: Julia<a class="headerlink" href="#entropyhub-julia" title="Permalink to this heading"></a></h1>
 <p class="centered">
 <strong>Links to installation files: <a class="reference external" href="https://github.com/MattWillFlood/EntropyHub.jl">GitHub</a> || <a class="reference external" href="https://juliahub.com/ui/Packages/EntropyHub/npy5E/">Julia Registry</a></strong></p><p><a class="reference external" href="https://juliahub.com/ui/Packages/EntropyHub/npy5E/">EntropyHub.jl</a> is the EntropyHub package for <em>Julia</em>.
-The complete documentation for <a class="reference external" href="https://docs.juliahub.com/EntropyHub/npy5E/0.2.0/">EntropyHub.jl can be found here</a></p>
-<a class="reference external image-reference" href="https://mattwillflood.github.io/EntropyHub.jl/"><img alt="../_images/EntropyHubJuliaLogo.png" class="align-center" src="../_images/EntropyHubJuliaLogo.png" style="width: 250px; height: 350px;" /></a>
+The complete documentation for <a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/">EntropyHub.jl can be found here</a></p>
+<a class="reference external image-reference" href="https://mattwillflood.github.io/EntropyHub.jl/stable/"><img alt="../_images/EntropyHubJuliaLogo.png" class="align-center" src="../_images/EntropyHubJuliaLogo.png" style="width: 250px; height: 350px;" /></a>
 <div class="toctree-wrapper compound">
 </div>
 <section id="requirements-installation">
@@ -267,7 +267,7 @@ <h2>Documentation &amp; Help:<a class="headerlink" href="#documentation-help" ti
 </div>
 <p>All information on the EntropyHub package is detailed in the <em>EntropyHub Guide</em>,
 a .pdf document available to <a class="reference download internal" download="" href="../_downloads/40d9c1910993d9509e60865d940bb066/EntropyHubGuide.pdf"><code class="xref download docutils literal notranslate"><span class="pre">download</span> <span class="pre">here</span></code></a>.</p>
-<p>The EntropyHub Julia API can be found at <a class="reference external" href="https://MattWillFlood.github.io/EntropyHub.jl/">https://MattWillFlood.github.io/EntropyHub.jl/</a>.</p>
+<p>The EntropyHub Julia API can be found at <a class="reference external" href="https://MattWillFlood.github.io/EntropyHub.jl/stable/">https://MattWillFlood.github.io/EntropyHub.jl/stable/</a>.</p>
 </section>
 </section>
 

diff --git a/julia/jlexamples.html b/julia/jlexamples.html
@@ -122,8 +122,8 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="EHjulia.html">EntropyHub - Julia</a><ul>
-<li class="toctree-l2"><a class="reference external" href="https://docs.juliahub.com/EntropyHub/npy5E/0.2.0/">EntropyHub.jl</a></li>
-<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/Examples/Examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/">EntropyHub.jl</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/Examples/Examples">Examples</a></li>
 </ul>
 </li>
 </ul>
@@ -155,8 +155,9 @@
   <section id="entropyhub-julia">
 <h1>EntropyHub: Julia<a class="headerlink" href="#entropyhub-julia" title="Permalink to this heading"></a></h1>
 <p><strong>EntropyHub.jl</strong> is the EntropyHub package for <em>Julia</em>.</p>
-<p>Examples in the Julia language can be found <a class="reference external" href="https://docs.juliahub.com/General/EntropyHub/stable/Examples/Examples/">here</a></p>
-<a class="reference external image-reference" href="https://mattwillflood.github.io/EntropyHub.jl/dev/Examples/Examples/"><img alt="../_images/EntropyHubJuliaLogo.png" class="align-center" src="../_images/EntropyHubJuliaLogo.png" style="width: 250px; height: 350px;" /></a>
+<p>Examples in the Julia language can be found <a href="#id1"><span class="problematic" id="id2">`here &lt;https://mattwillflood.github.io/EntropyHub.jl/stable/Examples/Examples/&gt;
+&gt;`_</span></a></p>
+<a class="reference external image-reference" href="https://mattwillflood.github.io/EntropyHub.jl/stable/Examples/Examples/"><img alt="../_images/EntropyHubJuliaLogo.png" class="align-center" src="../_images/EntropyHubJuliaLogo.png" style="width: 250px; height: 350px;" /></a>
 </section>
 
 

diff --git a/mat-modindex.html b/mat-modindex.html
@@ -128,8 +128,8 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="julia/EHjulia.html">EntropyHub - Julia</a><ul>
-<li class="toctree-l2"><a class="reference external" href="https://docs.juliahub.com/EntropyHub/npy5E/0.2.0/">EntropyHub.jl</a></li>
-<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/Examples/Examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/">EntropyHub.jl</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/Examples/Examples">Examples</a></li>
 </ul>
 </li>
 </ul>

diff --git a/matlab/EHmatlab.html b/matlab/EHmatlab.html
@@ -124,8 +124,8 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../julia/EHjulia.html">EntropyHub - Julia</a><ul>
-<li class="toctree-l2"><a class="reference external" href="https://docs.juliahub.com/EntropyHub/npy5E/0.2.0/">EntropyHub.jl</a></li>
-<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/Examples/Examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/">EntropyHub.jl</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/Examples/Examples">Examples</a></li>
 </ul>
 </li>
 </ul>

diff --git a/matlab/Functions/matBase.html b/matlab/Functions/matBase.html
@@ -124,8 +124,8 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../julia/EHjulia.html">EntropyHub - Julia</a><ul>
-<li class="toctree-l2"><a class="reference external" href="https://docs.juliahub.com/EntropyHub/npy5E/0.2.0/">EntropyHub.jl</a></li>
-<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/Examples/Examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/">EntropyHub.jl</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/Examples/Examples">Examples</a></li>
 </ul>
 </li>
 </ul>
@@ -879,6 +879,7 @@ <h2>Functions for estimating the entropy of a single univariate time series.<a c
 <li><p>[finegrain] <code class="docutils literal notranslate"><span class="pre">tpx</span></code> is the alpha parameter, a positive scalar (default = 1)</p></li>
 <li><p>[ampaware]  <code class="docutils literal notranslate"><span class="pre">tpx</span></code> is the A parameter, a value in range [0 1] (default = 0.5)</p></li>
 <li><p>[edge]      <code class="docutils literal notranslate"><span class="pre">tpx</span></code> is the r sensitivity parameter, a scalar &gt; 0 (default = 1)</p></li>
+<li><p>[phase]     <code class="docutils literal notranslate"><span class="pre">tpx</span></code> is the option to unwrap the phase angle of Hilbert-transformed signal, either [] or 1 (default = 0)</p></li>
 </ul>
 </dd>
 </dl>

diff --git a/matlab/Functions/matBidimensional.html b/matlab/Functions/matBidimensional.html
@@ -124,8 +124,8 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../julia/EHjulia.html">EntropyHub - Julia</a><ul>
-<li class="toctree-l2"><a class="reference external" href="https://docs.juliahub.com/EntropyHub/npy5E/0.2.0/">EntropyHub.jl</a></li>
-<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/Examples/Examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/">EntropyHub.jl</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/Examples/Examples">Examples</a></li>
 </ul>
 </li>
 </ul>

diff --git a/matlab/Functions/matCross.html b/matlab/Functions/matCross.html
@@ -124,8 +124,8 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../julia/EHjulia.html">EntropyHub - Julia</a><ul>
-<li class="toctree-l2"><a class="reference external" href="https://docs.juliahub.com/EntropyHub/npy5E/0.2.0/">EntropyHub.jl</a></li>
-<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/Examples/Examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/">EntropyHub.jl</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/Examples/Examples">Examples</a></li>
 </ul>
 </li>
 </ul>

diff --git a/matlab/Functions/matMultiscale.html b/matlab/Functions/matMultiscale.html
@@ -124,8 +124,8 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../julia/EHjulia.html">EntropyHub - Julia</a><ul>
-<li class="toctree-l2"><a class="reference external" href="https://docs.juliahub.com/EntropyHub/npy5E/0.2.0/">EntropyHub.jl</a></li>
-<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/Examples/Examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/">EntropyHub.jl</a></li>
+<li class="toctree-l2"><a class="reference external" href="https://mattwillflood.github.io/EntropyHub.jl/stable/Examples/Examples">Examples</a></li>
 </ul>
 </li>
 </ul>
@@ -390,7 +390,7 @@ <h2>Functions for estimating the multiscale entropy of a univariate time series.
 </div></blockquote>
 </li>
 <li><p><code class="docutils literal notranslate"><span class="pre">Refined</span></code>  - Refined-composite MSEn method. When <code class="docutils literal notranslate"><span class="pre">Refined</span> <span class="pre">==</span> <span class="pre">true</span></code> and the 
-entropy function specified by <code class="docutils literal notranslate"><span class="pre">Mobj</span></code> is <code class="docutils literal notranslate"><span class="pre">SampEn</span></code>, <code class="docutils literal notranslate"><span class="pre">cMSEn</span></code>
+entropy function specified by <code class="docutils literal notranslate"><span class="pre">Mobj</span></code> is <code class="docutils literal notranslate"><span class="pre">SampEn</span></code> or <code class="docutils literal notranslate"><span class="pre">FuzzEn</span></code>, <code class="docutils literal notranslate"><span class="pre">cMSEn</span></code>
 returns the refined-composite multiscale entropy (rcMSEn).  (default: false)</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">Plotx</span></code>    - When <code class="docutils literal notranslate"><span class="pre">Plotx</span> <span class="pre">==</span> <span class="pre">true</span></code>, returns a plot of the entropy value at 
 each time scale (i.e. the multiscale entropy curve) (default: false)</p></li>
@@ -422,6 +422,10 @@ <h2>Functions for estimating the multiscale entropy of a univariate time series.
 Physics Letters A 
 378.20 (2014): 1369-1374.</p>
 </dd>
+<dt>[6] Azami, Alberto Fernández, and Javier Escudero. </dt><dd><p>“Refined multiscale fuzzy entropy based on standard deviation 
+for biomedical signal analysis.” 
+Medical &amp; biological engineering &amp; computing 55 (2017): 2037-2052.</p>
+</dd>
 </dl>
 </dd>
 </dl>