whenxuan: create the notebook for vme

Author: wwhenxuan

README.md

@@ -100,7 +100,6 @@ plot_IMFs(signal, IMFs)             # per-channel panels
 | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :---: |
 | [`EMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_emd/emd.py) (Empirical Mode Decomposition) | [[paper]](https://royalsocietypublishing.org/doi/abs/10.1098/rspa.1998.0193) | [[code]](https://www.mathworks.com/help/signal/ref/emd.html) |   ✔️   |
 | [`MEMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_emd/memd.py) (Multivariate Empirical Mode Decomposition) | [[paper]](https://royalsocietypublishing.org/doi/full/10.1098/rspa.2009.0502) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/71270-fast-and-adaptive-multivariate-and-multidimensional-emd) |   ✔️   |
-| [`BEMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_emd2d/bemd.py) (Bidimensional Empirical Mode Decomposition) | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S0262885603000945) | [[code]](https://github.com/laszukdawid/PyEMD/blob/master/PyEMD/BEMD.py) |   ✔️   |
 | [`EEMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_emd/eemd.py) (Ensemble Empirical Mode Decomposition) | [[paper]](https://www.sciencedirect.com/topics/physics-and-astronomy/ensemble-empirical-mode-decomposition) | [[code]](https://github.com/laszukdawid/PyEMD/blob/master/PyEMD/EEMD.py) |   ✔️   |
 | [`REMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_emd/remd.py) (Robust Empirical Mode Decomposition) | [[paper]](https://www.sciencedirect.com/science/article/pii/S0019057821003785) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/70032-robust-empirical-mode-decomposition-remd) |   ✔️   |
 | [`EMD2D`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_emd2d/emd2d.py) (Empirical Mode Decomposition 2D for images) |          [[paper]](http://aquador.vovve.net/IEMD/)           |           [[code]](http://aquador.vovve.net/IEMD/)           |   ✔️   |

examples/vmd/vme.ipynb

@@ -73,5 +73,7 @@ include = ["pysdkit*"]
 "pysdkit._tid.data" = ["*.npy"]
 "pysdkit._imd" = ["data/*.npy"]
 "pysdkit._imd.data" = ["*.npy"]
+"pysdkit._vmd" = ["data/*.npy"]
+"pysdkit._vmd.data" = ["*.npy"]
 "pysdkit._tfa" = ["data/*.npy"]
 "pysdkit._tfa.data" = ["*.npy"]

pyproject.toml

@@ -86,7 +86,7 @@
 from ._vmd import MVMD
 
 # Variational Mode Extraction, to extract a specific mode from the signal
-from ._vmd import VME
+from ._vmd import VME, vme
 
 # Orthogonalized Variational Mode Decomposition
 from ._vmd import OVMD
@@ -159,8 +159,7 @@
 
 
 def greet():
-    print(
-        r"""
+    print(r"""
  ____          ____   ____   _  __ _  _   
 |  _ \  _   _ / ___| |  _ \ | |/ /(_)| |_ 
 | |_) || | | |\___ \ | | | || ' / | || __|
@@ -170,14 +169,12 @@ def greet():
     
 A Python library for signal decomposition algorithms.
 https://github.com/wwhenxuan/PySDKit
-"""
-    )
+""")
 
 
 def print_functions():
     """"""
-    print(
-        """
+    print("""
 _______________________________________________________________
 Algorithm Name                                  | Abbreviation
 _______________________________________________________________
@@ -233,8 +230,7 @@ def print_functions():
 Multiple Seasonal-Trend decomposition (LOESS)   |    MSTL
 Hilbert-Huang Transform                         |    HHT
 _______________________________________________________________
-"""
-    )
+""")
 
 
 __all__ = [
@@ -277,6 +273,7 @@ def print_functions():
     "DD_ACMD",
     "MVMD",
     "VME",
+    "vme",
     "OVMD",
     "svmd",
     "SVMD",