Skip to content

Commit

Permalink
Website Update for v2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
MattWillFlood committed Apr 24, 2024
1 parent cc68cb6 commit 6bd5944
Show file tree
Hide file tree
Showing 132 changed files with 7,695 additions and 515 deletions.
38 changes: 35 additions & 3 deletions docs/EHupdates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,38 @@ Latest Updates

..............................................................

April 2024
############

Version 2.0 is out now!
=======================

| Since the introduction of multivariate entropy methods over a decade ago, the utilization of multivariate and multivariate multiscale entropy methods has seen a notable increase in recent years.
| Systems comprising multiple dynamically related components are ubiquitous in many research fields and multivariate entropies provide a powerful method for estimating the complexity of such systems.
| With EntropyHub v2.0, you can now apply many multivariate and multivariate multiscale methods with the ease, robust functionality and extensive documentation for which EntropyHub is acclaimed.
**+ New multivariate methods**
| Five new multivariate entropy functions incorporating several method-specific variations
| + `Multivariate Sample Entropy <https://journals.aps.org/pre/abstract/10.1103/PhysRevE.84.061918>`_
| + `Multivariate Fuzzy Entropy <https://www.mdpi.com/1099-4300/19/1/2>`_ [++ many fuzzy functions]
| + `Multivariate Dispersion Entropy <https://www.mdpi.com/1099-4300/21/9/913>`_ [++ many symbolic sequence transforms]
| + `Multivariate Cosine Similarity Entropy <https://www.mdpi.com/1099-4300/24/9/1287>`_
| + Multivariate Permutation Entropy [++ *amplitude-aware*, *edge*, *phase*, *weighted* and *modified* variants]
**+ New multivariate multiscale methods**
| Two new multivariate multiscale entropy functions
| + `Multivariate Multiscale Entropy <https://journals.aps.org/pre/abstract/10.1103/PhysRevE.84.061918>`_ [++ coarse, modified and generalized graining procedures]
| + `Composite and Refined-composite Multivariate Multiscale Entropy <https://link.springer.com/article/10.1007/s11517-017-1647-5>`_
**+ Extra signal processing tools**
| + **WindowData()** is a new function that allows users to segment data (univariate or multivariate time series) into windows with/without overlapping samples!
| This allows users to calculate entropy on subsequences of their data to perform analyses with greater time resolution.
| Other little fixes...
**Docs edits**
| - Examples in the www.EntropyHub.xyz documentation were updated to match the latest package syntax.

March 2024
############
Expand Down Expand Up @@ -144,10 +176,10 @@ December 2021

**Version Update - EntropyHub v0.2**

EntropyHub v0.2 includes two new bidimensional entropy methods:
**+ EntropyHub v0.2 includes two new bidimensional entropy methods:**

| * `Bidimensional permutation entropy (PermEn2D) <https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0040689>`_
| * `Bidimensional Espinosa entropy (EspEn2D) <https://www.mdpi.com/1099-4300/23/10/1261>`_
| + `Bidimensional permutation entropy (PermEn2D) <https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0040689>`_
| + `Bidimensional Espinosa entropy (EspEn2D) <https://www.mdpi.com/1099-4300/23/10/1261>`_
..............................................................

Expand Down
Binary file modified docs/_build/doctrees/EHupdates.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file added docs/_build/doctrees/matlab/Examples/Ex11.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/matlab/Examples/Ex12.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/matlab/Examples/Ex13.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/matlab/Examples/Ex4.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/matlab/Examples/Ex8.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/matlab/Examples/Ex9.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/matlab/Functions/matBidimensional.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/matlab/Functions/matMultiscale.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/matlab/Functions/matMultiscaleCross.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/_build/doctrees/matlab/matAPI.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/matlab/matexamples.doctree
Binary file not shown.
Binary file not shown.
Binary file added docs/_build/doctrees/python/Examples/Ex12.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/python/Examples/Ex13.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/python/Examples/Ex4.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/python/Examples/Ex8.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/python/Examples/Ex9.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/python/Functions/Base.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/python/Functions/Bidimensional.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/python/Functions/Cross.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/python/Functions/Multiscale.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/python/Functions/MultiscaleCross.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/_build/doctrees/python/pyAPI.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/python/pyexamples.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: a08dde90a3c13e8b0243414d25c4c8a4
config: 4c42f4feeefbbc77a5eae3d957aaf51a
tags: 645f666f9bcd5a90fca523b33c5a78b7
88 changes: 80 additions & 8 deletions docs/_build/html/EHupdates.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Latest Updates &mdash; EntropyHub 1.0 documentation</title>
<title>Latest Updates &mdash; EntropyHub 2.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
Expand Down Expand Up @@ -63,13 +63,22 @@
<li class="toctree-l3"><a class="reference internal" href="matlab/Functions/matCross.html"> Cross-Entropies</a><ul class="simple">
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="matlab/Functions/matMultivariate.html"> Multivariate Entropies</a><ul class="simple">
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="matlab/Functions/matBidimensional.html"> Bidimensional (2D) Entropies</a><ul class="simple">
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="matlab/Functions/matMultiscale.html"> Multiscale Entropies</a><ul class="simple">
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="matlab/Functions/matMultiscaleCross.html"> Multiscale Cross-Entropies</a><ul class="simple">
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="matlab/Functions/matBidimensional.html"> Bidimensional (2D) Entropies</a><ul class="simple">
<li class="toctree-l3"><a class="reference internal" href="matlab/Functions/matMultivariateMultiscale.html"> Multivariate Multiscale Entropies</a><ul class="simple">
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="matlab/Functions/matOther.html"> Other Functions</a><ul class="simple">
</ul>
</li>
</ul>
Expand All @@ -81,10 +90,13 @@
<li class="toctree-l3"><a class="reference internal" href="matlab/Examples/Ex4.html"> Ex. 4 - Cross-Distribution Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="matlab/Examples/Ex5.html"> Ex. 5 - Multiscale Entropy Object</a></li>
<li class="toctree-l3"><a class="reference internal" href="matlab/Examples/Ex6.html"> Ex. 6 - Multiscale [Increment] Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="matlab/Examples/Ex7.html"> Ex. 7 - Refined Multisclae [Sample] Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="matlab/Examples/Ex7.html"> Ex. 7 - Refined Multiscale [Sample] Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="matlab/Examples/Ex8.html"> Ex. 8 - Composite Multiscale Cross-[Approximate] Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="matlab/Examples/Ex9.html"> Ex. 9 - Hierarchical Multiscale corrected Cross-[Conditional] Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="matlab/Examples/Ex10.html"> Ex. 10 - Bidimensional Fuzzy Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="matlab/Examples/Ex11.html"> Ex. 11 - Multivariate Dispersion Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="matlab/Examples/Ex12.html"> Ex. 12 - Refined-composite Multivariate Multiscale Fuzzy Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="matlab/Examples/Ex13.html"> Ex. 13 - Windowing data with WindowData()</a></li>
</ul>
</li>
</ul>
Expand All @@ -97,13 +109,22 @@
<li class="toctree-l3"><a class="reference internal" href="python/Functions/Cross.html"> Cross-Entropies</a><ul class="simple">
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="python/Functions/Multivariate.html"> Multivariate Entropies</a><ul class="simple">
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="python/Functions/Bidimensional.html"> Bidimensional (2D) Entropies</a><ul class="simple">
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="python/Functions/Multiscale.html"> Multiscale Entropies</a><ul class="simple">
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="python/Functions/MultiscaleCross.html"> Multiscale Cross-Entropies</a><ul class="simple">
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="python/Functions/Bidimensional.html"> Bidimensional (2D) Entropies</a><ul class="simple">
<li class="toctree-l3"><a class="reference internal" href="python/Functions/MultivariateMultiscale.html"> Multivariate Multiscale Entropies</a><ul class="simple">
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="python/Functions/Other.html"> Other Functions</a><ul class="simple">
</ul>
</li>
</ul>
Expand All @@ -115,10 +136,13 @@
<li class="toctree-l3"><a class="reference internal" href="python/Examples/Ex4.html"> Ex. 4 - Cross-Distribution Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/Examples/Ex5.html"> Ex. 5 - Multiscale Entropy Object</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/Examples/Ex6.html"> Ex. 6 - Multiscale [Increment] Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/Examples/Ex7.html"> Ex. 7 - Refined Multisclae [Sample] Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/Examples/Ex7.html"> Ex. 7 - Refined Multiscale [Sample] Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/Examples/Ex8.html"> Ex. 8 - Composite Multiscale Cross-[Approximate] Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/Examples/Ex9.html"> Ex. 9 - Hierarchical Multiscale corrected Cross-[Conditional] Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/Examples/Ex10.html"> Ex. 10 - Bidimensional Fuzzy Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/Examples/Ex11.html"> Ex. 11 - Multivariate Dispersion Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/Examples/Ex12.html"> Ex. 12 - [Generalized] Refined-composite Multivariate Multiscale Fuzzy Entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/Examples/Ex13.html"> Ex. 13 - Windowing data with WindowData()</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -161,6 +185,52 @@ <h1>Latest Updates<a class="headerlink" href="#latest-updates" title="Permalink
<div class="toctree-wrapper compound">
</div>
<hr class="docutils" />
<section id="april-2024">
<h2>April 2024<a class="headerlink" href="#april-2024" title="Permalink to this heading"></a></h2>
<section id="version-2-0-is-out-now">
<h3>Version 2.0 is out now!<a class="headerlink" href="#version-2-0-is-out-now" title="Permalink to this heading"></a></h3>
<div class="line-block">
<div class="line">Since the introduction of multivariate entropy methods over a decade ago, the utilization of multivariate and multivariate multiscale entropy methods has seen a notable increase in recent years.</div>
<div class="line">Systems comprising multiple dynamically related components are ubiquitous in many research fields and multivariate entropies provide a powerful method for estimating the complexity of such systems.</div>
<div class="line">With EntropyHub v2.0, you can now apply many multivariate and multivariate multiscale methods with the ease, robust functionality and extensive documentation for which EntropyHub is acclaimed.</div>
</div>
<blockquote>
<div><dl>
<dt><strong>+ New multivariate methods</strong></dt><dd><div class="line-block">
<div class="line">Five new multivariate entropy functions incorporating several method-specific variations</div>
<div class="line">+ <a class="reference external" href="https://journals.aps.org/pre/abstract/10.1103/PhysRevE.84.061918">Multivariate Sample Entropy</a></div>
<div class="line">+ <a class="reference external" href="https://www.mdpi.com/1099-4300/19/1/2">Multivariate Fuzzy Entropy</a> [++ many fuzzy functions]</div>
<div class="line">+ <a class="reference external" href="https://www.mdpi.com/1099-4300/21/9/913">Multivariate Dispersion Entropy</a> [++ many symbolic sequence transforms]</div>
<div class="line">+ <a class="reference external" href="https://www.mdpi.com/1099-4300/24/9/1287">Multivariate Cosine Similarity Entropy</a></div>
<div class="line">+ Multivariate Permutation Entropy [++ <em>amplitude-aware</em>, <em>edge</em>, <em>phase</em>, <em>weighted</em> and <em>modified</em> variants]</div>
</div>
</dd>
<dt><strong>+ New multivariate multiscale methods</strong></dt><dd><div class="line-block">
<div class="line">Two new multivariate multiscale entropy functions</div>
<div class="line">+ <a class="reference external" href="https://journals.aps.org/pre/abstract/10.1103/PhysRevE.84.061918">Multivariate Multiscale Entropy</a> [++ coarse, modified and generalized graining procedures]</div>
<div class="line">+ <a class="reference external" href="https://link.springer.com/article/10.1007/s11517-017-1647-5">Composite and Refined-composite Multivariate Multiscale Entropy</a></div>
</div>
</dd>
<dt><strong>+ Extra signal processing tools</strong></dt><dd><div class="line-block">
<div class="line">+ <strong>WindowData()</strong> is a new function that allows users to segment data (univariate or multivariate time series) into windows with/without overlapping samples!</div>
<div class="line">This allows users to calculate entropy on subsequences of their data to perform analyses with greater time resolution.</div>
</div>
</dd>
</dl>
</div></blockquote>
<div class="line-block">
<div class="line">Other little fixes…</div>
</div>
<blockquote>
<div><dl>
<dt><strong>Docs edits</strong></dt><dd><div class="line-block">
<div class="line">- Examples in the www.EntropyHub.xyz documentation were updated to match the latest package syntax.</div>
</div>
</dd>
</dl>
</div></blockquote>
</section>
</section>
<section id="march-2024">
<h2>March 2024<a class="headerlink" href="#march-2024" title="Permalink to this heading"></a></h2>
<section id="version-1-0-is-here">
Expand Down Expand Up @@ -288,11 +358,13 @@ <h2>February 2022<a class="headerlink" href="#february-2022" title="Permalink to
<section id="december-2021">
<h2>December 2021<a class="headerlink" href="#december-2021" title="Permalink to this heading"></a></h2>
<p><strong>Version Update - EntropyHub v0.2</strong></p>
<p>EntropyHub v0.2 includes two new bidimensional entropy methods:</p>
<blockquote>
<div><p><strong>+ EntropyHub v0.2 includes two new bidimensional entropy methods:</strong></p>
<div class="line-block">
<div class="line">* <a class="reference external" href="https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0040689">Bidimensional permutation entropy (PermEn2D)</a></div>
<div class="line">* <a class="reference external" href="https://www.mdpi.com/1099-4300/23/10/1261">Bidimensional Espinosa entropy (EspEn2D)</a></div>
<div class="line">+ <a class="reference external" href="https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0040689">Bidimensional permutation entropy (PermEn2D)</a></div>
<div class="line">+ <a class="reference external" href="https://www.mdpi.com/1099-4300/23/10/1261">Bidimensional Espinosa entropy (EspEn2D)</a></div>
</div>
</div></blockquote>
</section>
<hr class="docutils" />
<section id="november-2021">
Expand Down
Loading

0 comments on commit 6bd5944

Please sign in to comment.