Modal-Decomposition 0.2.1__tar.gz → 0.5.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (127) hide show
  1. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/MANIFEST.in +13 -0
  2. {Modal-Decomposition-0.2.1/src/Modal_Decomposition.egg-info → modal_decomposition-0.5.0}/PKG-INFO +74 -17
  3. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/README.md +66 -6
  4. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/pyproject.toml +5 -8
  5. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/setup.py +21 -1
  6. modal_decomposition-0.5.0/src/Modal_Decomposition/Base/CPU.py +73 -0
  7. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition/Base/Cache.py +432 -420
  8. modal_decomposition-0.5.0/src/Modal_Decomposition/Base/Chunk.py +373 -0
  9. modal_decomposition-0.5.0/src/Modal_Decomposition/Base/Memory.py +356 -0
  10. modal_decomposition-0.5.0/src/Modal_Decomposition/Base/Seed.py +109 -0
  11. modal_decomposition-0.5.0/src/Modal_Decomposition/Base/__init__.py +42 -0
  12. modal_decomposition-0.5.0/src/Modal_Decomposition/CEEFD.py +318 -0
  13. modal_decomposition-0.5.0/src/Modal_Decomposition/CEEMD.py +367 -0
  14. modal_decomposition-0.5.0/src/Modal_Decomposition/CEEMDAN.py +577 -0
  15. modal_decomposition-0.5.0/src/Modal_Decomposition/Define/ClassDefine.py +178 -0
  16. modal_decomposition-0.5.0/src/Modal_Decomposition/Define/ConfigDefine.py +48 -0
  17. modal_decomposition-0.5.0/src/Modal_Decomposition/Define/ConstDefine.py +149 -0
  18. {Modal-Decomposition-0.2.1/src/Modal_Decomposition/Base → modal_decomposition-0.5.0/src/Modal_Decomposition/Define}/PathDefine.py +4 -5
  19. {Modal-Decomposition-0.2.1/src/Modal_Decomposition/Base → modal_decomposition-0.5.0/src/Modal_Decomposition/Define}/TextDefine.py +2 -0
  20. modal_decomposition-0.5.0/src/Modal_Decomposition/Define/__init__.py +18 -0
  21. modal_decomposition-0.5.0/src/Modal_Decomposition/EEMD.py +348 -0
  22. modal_decomposition-0.5.0/src/Modal_Decomposition/EFD.py +202 -0
  23. modal_decomposition-0.5.0/src/Modal_Decomposition/EMD.py +442 -0
  24. modal_decomposition-0.5.0/src/Modal_Decomposition/EWT.py +1322 -0
  25. modal_decomposition-0.5.0/src/Modal_Decomposition/Error/__init__.py +15 -0
  26. modal_decomposition-0.5.0/src/Modal_Decomposition/FMD.py +625 -0
  27. modal_decomposition-0.5.0/src/Modal_Decomposition/ICEEMDAN.py +598 -0
  28. modal_decomposition-0.5.0/src/Modal_Decomposition/LMD.py +557 -0
  29. modal_decomposition-0.5.0/src/Modal_Decomposition/MEMD.py +430 -0
  30. modal_decomposition-0.5.0/src/Modal_Decomposition/Operator/Daubechies_polynomial.py +29 -0
  31. modal_decomposition-0.5.0/src/Modal_Decomposition/Operator/Empirical_wavelet.py +36 -0
  32. modal_decomposition-0.5.0/src/Modal_Decomposition/Operator/__init__.py +2 -0
  33. modal_decomposition-0.5.0/src/Modal_Decomposition/RPSEMD.py +504 -0
  34. modal_decomposition-0.5.0/src/Modal_Decomposition/SSA.py +566 -0
  35. modal_decomposition-0.5.0/src/Modal_Decomposition/SVMD.py +278 -0
  36. modal_decomposition-0.5.0/src/Modal_Decomposition/Utils/Check.py +555 -0
  37. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition/Utils/Envelope.py +152 -170
  38. modal_decomposition-0.5.0/src/Modal_Decomposition/Utils/Hilbert.py +48 -0
  39. modal_decomposition-0.5.0/src/Modal_Decomposition/Utils/Mirror.py +436 -0
  40. modal_decomposition-0.5.0/src/Modal_Decomposition/Utils/Monotonicity.py +309 -0
  41. modal_decomposition-0.5.0/src/Modal_Decomposition/Utils/Peaks.py +319 -0
  42. modal_decomposition-0.5.0/src/Modal_Decomposition/Utils/Poly.py +31 -0
  43. modal_decomposition-0.5.0/src/Modal_Decomposition/Utils/Slepian.py +441 -0
  44. modal_decomposition-0.5.0/src/Modal_Decomposition/Utils/_Hilbert/__init__.py +129 -0
  45. modal_decomposition-0.5.0/src/Modal_Decomposition/Utils/_Hilbert/_fft.py +105 -0
  46. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition/Utils/_Hilbert/_fht.py +47 -6
  47. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition/Utils/_Hilbert/_fht_native.pyx +122 -103
  48. modal_decomposition-0.5.0/src/Modal_Decomposition/Utils/_Slepian/C.py +228 -0
  49. modal_decomposition-0.5.0/src/Modal_Decomposition/Utils/_Slepian/_C/slepian_core.c +608 -0
  50. modal_decomposition-0.5.0/src/Modal_Decomposition/Utils/_Slepian/_C/slepian_dpss.h +67 -0
  51. modal_decomposition-0.5.0/src/Modal_Decomposition/Utils/_Slepian/__init__.py +1 -0
  52. modal_decomposition-0.5.0/src/Modal_Decomposition/Utils/_Slepian/numpy_slepian.py +297 -0
  53. modal_decomposition-0.5.0/src/Modal_Decomposition/Utils/__init__.py +11 -0
  54. modal_decomposition-0.5.0/src/Modal_Decomposition/VMD.py +1136 -0
  55. modal_decomposition-0.5.0/src/Modal_Decomposition/__init__.py +121 -0
  56. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0/src/Modal_Decomposition.egg-info}/PKG-INFO +74 -17
  57. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition.egg-info/SOURCES.txt +21 -30
  58. modal_decomposition-0.5.0/src/Modal_Decomposition.egg-info/requires.txt +9 -0
  59. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Base/ClassDefine.py +0 -129
  60. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Base/ConfigDefine.py +0 -22
  61. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Base/ConstDefine.py +0 -51
  62. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Base/__init__.py +0 -24
  63. Modal-Decomposition-0.2.1/src/Modal_Decomposition/CEEFD.py +0 -161
  64. Modal-Decomposition-0.2.1/src/Modal_Decomposition/CEEMD.py +0 -149
  65. Modal-Decomposition-0.2.1/src/Modal_Decomposition/CEEMDAN.py +0 -150
  66. Modal-Decomposition-0.2.1/src/Modal_Decomposition/EEMD.py +0 -117
  67. Modal-Decomposition-0.2.1/src/Modal_Decomposition/EFD.py +0 -144
  68. Modal-Decomposition-0.2.1/src/Modal_Decomposition/EMD.py +0 -417
  69. Modal-Decomposition-0.2.1/src/Modal_Decomposition/EWT.py +0 -110
  70. Modal-Decomposition-0.2.1/src/Modal_Decomposition/EWT_new.py +0 -110
  71. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Error/RealizationError.py +0 -12
  72. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Error/__init__.py +0 -7
  73. Modal-Decomposition-0.2.1/src/Modal_Decomposition/FMD.py +0 -418
  74. Modal-Decomposition-0.2.1/src/Modal_Decomposition/ICEEMDAN.py +0 -255
  75. Modal-Decomposition-0.2.1/src/Modal_Decomposition/LMD.py +0 -400
  76. Modal-Decomposition-0.2.1/src/Modal_Decomposition/MEMD.py +0 -285
  77. Modal-Decomposition-0.2.1/src/Modal_Decomposition/RPSEMD.py +0 -149
  78. Modal-Decomposition-0.2.1/src/Modal_Decomposition/SSA.py +0 -450
  79. Modal-Decomposition-0.2.1/src/Modal_Decomposition/SVMD.py +0 -209
  80. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Utils/Check.py +0 -368
  81. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Utils/Chunk.py +0 -488
  82. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Utils/Hilbert.py +0 -38
  83. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Utils/Memory.py +0 -160
  84. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Utils/Mirror.py +0 -144
  85. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Utils/Monotonicity.py +0 -407
  86. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Utils/Peaks.py +0 -220
  87. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Utils/Seed.py +0 -104
  88. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Utils/Spline.py +0 -324
  89. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Utils/_Hilbert/__init__.py +0 -102
  90. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Utils/_Hilbert/_fft.py +0 -0
  91. Modal-Decomposition-0.2.1/src/Modal_Decomposition/Utils/__init__.py +0 -216
  92. Modal-Decomposition-0.2.1/src/Modal_Decomposition/VMD.py +0 -99
  93. Modal-Decomposition-0.2.1/src/Modal_Decomposition/VMD_new.py +0 -108
  94. Modal-Decomposition-0.2.1/src/Modal_Decomposition/_Registry.py +0 -39
  95. Modal-Decomposition-0.2.1/src/Modal_Decomposition/_SVMD_numba.py +0 -17
  96. Modal-Decomposition-0.2.1/src/Modal_Decomposition/__init__.py +0 -154
  97. Modal-Decomposition-0.2.1/src/Modal_Decomposition.egg-info/requires.txt +0 -13
  98. Modal-Decomposition-0.2.1/tests/test_cache.py +0 -494
  99. Modal-Decomposition-0.2.1/tests/test_chunk.py +0 -364
  100. Modal-Decomposition-0.2.1/tests/test_contract.py +0 -82
  101. Modal-Decomposition-0.2.1/tests/test_emd.py +0 -268
  102. Modal-Decomposition-0.2.1/tests/test_envelope.py +0 -111
  103. Modal-Decomposition-0.2.1/tests/test_facade.py +0 -50
  104. Modal-Decomposition-0.2.1/tests/test_fht.py +0 -23
  105. Modal-Decomposition-0.2.1/tests/test_fmd_lmd_refactor.py +0 -63
  106. Modal-Decomposition-0.2.1/tests/test_import.py +0 -9
  107. Modal-Decomposition-0.2.1/tests/test_montonic.py +0 -215
  108. Modal-Decomposition-0.2.1/tests/test_peaks.py +0 -209
  109. Modal-Decomposition-0.2.1/tests/test_reconstruction.py +0 -41
  110. Modal-Decomposition-0.2.1/tests/test_registry.py +0 -67
  111. Modal-Decomposition-0.2.1/tests/test_seed.py +0 -92
  112. Modal-Decomposition-0.2.1/tests/test_spline.py +0 -306
  113. Modal-Decomposition-0.2.1/tests/test_utils.py +0 -590
  114. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/LICENSE +0 -0
  115. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/setup.cfg +0 -0
  116. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition/Utils/_Hilbert/_C/_fht/am_sysdep.c +0 -0
  117. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition/Utils/_Hilbert/_C/_fht/am_sysdep.h +0 -0
  118. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition/Utils/_Hilbert/_C/_fht/math_const.h +0 -0
  119. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition/Utils/_Hilbert/_C/_fht/transforms.c +0 -0
  120. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition/Utils/_Hilbert/_C/_fht/transforms.h +0 -0
  121. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition/Utils/_Hilbert/_fir.py +0 -0
  122. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition/Utils/_Hilbert/_forth_order_wave.py +0 -0
  123. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition/Utils/_Hilbert/_kramers_kronig.py +0 -0
  124. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition/Utils/_Hilbert/_scipy_backend.py +0 -0
  125. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition/Utils/_Hilbert/_wave.py +0 -0
  126. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition.egg-info/dependency_links.txt +0 -0
  127. {Modal-Decomposition-0.2.1 → modal_decomposition-0.5.0}/src/Modal_Decomposition.egg-info/top_level.txt +0 -0
@@ -6,3 +6,16 @@ include LICENSE
6
6
  include README.md
7
7
  recursive-include src/Modal_Decomposition/Utils/_Hilbert/_C *
8
8
  include src/Modal_Decomposition/Utils/_Hilbert/_fht_native.pyx
9
+ recursive-include src/Modal_Decomposition/Utils/_Slepian/_C *.c *.h
10
+
11
+ # ??????????: ??/??/??/??/???????? sdist
12
+ prune tests
13
+ prune docs
14
+ prune table
15
+ prune fig
16
+ prune explore
17
+ prune ref
18
+ prune .scratch
19
+ prune .github
20
+ prune .vscode
21
+ global-exclude *.py[cod] __pycache__ *.ipynb
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: Modal-Decomposition
3
- Version: 0.2.1
3
+ Version: 0.5.0
4
4
  Summary: a package for modal decomposition
5
5
  Author-email: Mao_HaoChuan <2215269365@qq.com>
6
6
  License: Apache-2.0
@@ -18,16 +18,13 @@ Requires-Python: >=3.10
18
18
  Description-Content-Type: text/markdown
19
19
  License-File: LICENSE
20
20
  Requires-Dist: numpy
21
- Requires-Dist: EMD-signal
22
- Requires-Dist: ewtpy
23
- Requires-Dist: scipy
24
- Requires-Dist: vmdpy
25
21
  Requires-Dist: psutil
26
- Provides-Extra: dev
27
- Requires-Dist: pytest>=7.0; extra == "dev"
28
- Requires-Dist: black; extra == "dev"
29
- Provides-Extra: plot
30
- Requires-Dist: matplotlib; extra == "plot"
22
+ Requires-Dist: scipy
23
+ Provides-Extra: cupy
24
+ Requires-Dist: cupy-cuda12x; extra == "cupy"
25
+ Provides-Extra: pyfftw
26
+ Requires-Dist: pyfftw; extra == "pyfftw"
27
+ Dynamic: license-file
31
28
 
32
29
  # Modal-Decomposition
33
30
 
@@ -52,6 +49,7 @@ algorithms (or benchmarking them against each other) is a one-line change.
52
49
  | EFD | Empirical Fourier Decomposition | `Function.EFD(S)` | [10.1016/j.ymssp.2021.108155](https://www.sciencedirect.com/science/article/abs/pii/S0888327021005355?via%3Dihub) |
53
50
  | EMD | Empirical Mode Decomposition | `Function.EMD(S)` | [10.1098/rspa.1998.0193](https://www.semanticscholar.org/paper/The-empirical-mode-decomposition-and-the-Hilbert-Huang-Shen/3842d81b0375dae8ae92734aa2a5d4aeed7a91d1) |
54
51
  | EWT | Empirical Wavelet Transform | `Function.EWT(S)` | [10.48550/arXiv.2304.06274](https://arxiv.org/abs/2304.06274) |
52
+ | EWTpy | Empirical Wavelet Transform (optional `ewtpy` backend) | `Function.EWTpy(S)` | [10.48550/arXiv.2304.06274](https://arxiv.org/abs/2304.06274) |
55
53
  | FMD | Filtered Mode Decomposition | `Function.FMD(S)` | [10.1109/TIE.2022.3156156](https://ieeexplore.ieee.org/document/9732251) |
56
54
  | ICEEMDAN | Improved Complete Ensemble Empirical Mode Decomposition with Adaptive Noise | `Function.ICEEMDAN(S)` | [10.1007/s10470-021-01901-3](https://link.springer.com/article/10.1007/s10470-021-01901-3#citeas) |
57
55
  | LMD | Local Mean Decomposition | `Function.LMD(S)` | [10.1098/rsif.2005.0058](https://royalsocietypublishing.org/doi/10.1098/rsif.2005.0058) |
@@ -95,18 +93,41 @@ Requires **Python >= 3.10**.
95
93
  |-------------|-----------------------------------------------------|
96
94
  | numpy | core arrays and vectorized kernels |
97
95
  | scipy | splines, envelope / Hilbert, filtering, peaks, FFT |
98
- | EMD-signal (PyEMD) | EMD, EEMD, CEEMDAN (and ensemble chains) |
99
- | ewtpy | EWT |
100
- | vmdpy | VMD |
96
+ | EMD-signal (PyEMD) | **EEMD and CEEMDAN only** — the last remaining third-party decomposition dependency |
101
97
  | psutil | available-memory reading for the memmap policy |
102
98
 
103
99
  > Please install `EMD-signal`, not `PyEMD` (the latter is an unrelated older package).
104
100
 
101
+ **PyEMD is the only third-party decomposition backend left.** Every other
102
+ method — `EMD`, `CEEMD`, `ICEEMDAN`, `RPSEMD`, `VMD`, `EWT`, `LMD`, `FMD`,
103
+ `EFD`, `CEEFD`, `SSA`, `SVMD`, `MEMD` — is implemented inside this library and
104
+ needs nothing beyond numpy/scipy. Only `EEMD` and `CEEMDAN` still delegate to
105
+ PyEMD, and **that dependency is being removed**: the `0.3.x` line exists
106
+ precisely to finish porting those two remaining branches, after which the
107
+ library stands on its own (see [Roadmap](#roadmap)).
108
+
109
+ `vmdpy` and `ewtpy` are **not** required: the native `VMD` / `EWT` replace them
110
+ entirely. `vmdpy` survives only as an optional parity-check backend
111
+ (`Class.VMD(vmdpy=True)`) and `EWTpy` / `ewtpy` only as an optional
112
+ reference-implementation adapter. Both are imported lazily, so neither is a
113
+ runtime dependency.
114
+
115
+ `EWT` (Empirical Wavelet Transform) is implemented **inside this library** and
116
+ needs no third-party package. The ewtpy-backed variant `EWTpy` is **optional**:
117
+ `ewtpy` is imported lazily (via `cache.import_module`) only when you actually
118
+ call `Function.EWTpy` / `Class.EWTpy(...).decompose(...)`, so a missing `ewtpy`
119
+ never affects the rest of the library — install it with
120
+ `pip install Modal-Decomposition[ewtpy]` (or plain `pip install ewtpy`) if you
121
+ want that entry.
122
+
105
123
  Optional extras (not required at runtime): `[dev]` (pytest, black) and
106
124
  `[plot]` (matplotlib). `numba` may be installed to activate the optional
107
125
  `"numba"` backend of `Utils.Peaks` / `SVMD`; everything degrades gracefully
108
126
  without it.
109
127
 
128
+ Accessing any method other than `EEMD` / `CEEMDAN` therefore never triggers a
129
+ PyEMD import at all — `EMD` in particular is the native sifting engine.
130
+
110
131
  ## Quick Start
111
132
 
112
133
  ```python
@@ -200,19 +221,55 @@ src/Modal_Decomposition/
200
221
  ├── __init__.py Class / Function namespaces + global API
201
222
  ├── <METHOD>.py 1 Config dataclass + 1 Decomposer per method
202
223
  ├── EMD.py native EMD engine (PyEMD-free; original EMD_new,
203
- │ registered as the public "EMD")
224
+ │ registered as the public "EMD"). Only EEMD / CEEMDAN
225
+ │ still reach PyEMD; the 0.3.x line removes that too
204
226
  ├── _Registry.py class registry (registration at import time)
205
227
  ├── Base/ Decomposer ABC, DecompositionResult, Config,
206
228
  │ import Cache, metadata tables, size constants
207
229
  └── Utils/ Check / Chunk / Peaks / Mirror / Spline / Envelope /
208
- Hilbert / Monotonicity / Memory / Seed
209
- (+ _Hilbert FHT backends)
230
+ Hilbert / Monotonicity / Memory / Seed / FFT / Slepian
231
+ (+ _Hilbert FHT and _Slepian C backends)
210
232
  tests/ pytest suite + benchmarking harnesses (comparison/,
211
233
  ssa/, test_memory/) against PyEMD and PySDKit
212
234
  ```
213
235
 
236
+ ## Roadmap
237
+
238
+ **`0.3.0` is the current release.** PyEMD is the only third-party
239
+ decomposition backend still in use, and it is on the way out; the version
240
+ plan splits the remaining work into two lines:
241
+
242
+ | Line | Scope |
243
+ |------|-------|
244
+ | **`0.3.x`** | **Finish removing PyEMD.** Port the two remaining PyEMD-backed branches (`EEMD`, `CEEMDAN`) onto the native engine, so the whole package runs on numpy/scipy alone. Nothing else is planned for this line — bug fixups are deliberately deferred. |
245
+ | **`0.4.0`** | **First fully self-developed release.** With every method native, this line takes on the remaining bug fixups and correctness work across the library. |
246
+
214
247
  ## Changelog
215
248
 
249
+ ### 0.3.0
250
+
251
+ - **Version line opened.** PyEMD is now the *only* third-party decomposition
252
+ dependency: `EEMD` and `CEEMDAN` are the sole methods still backed by it,
253
+ and removing that dependency is the entire scope of the `0.3.x` line.
254
+ Everything else — `EMD`, `CEEMD`, `ICEEMDAN`, `RPSEMD`, `VMD`, `EWT`,
255
+ `LMD`, `FMD`, `EFD`, `CEEFD`, `SSA`, `SVMD`, `MEMD` — is already native.
256
+ - `vmdpy` and `ewtpy` are demoted to optional parity-check / reference
257
+ backends (`Class.VMD(vmdpy=True)`, `Class.EWTpy`), no longer runtime
258
+ dependencies of `VMD` / `EWT`.
259
+ - `EWT` is fully re-implemented in-library (boundary detection, filter bank,
260
+ transform and inverse) and no longer requires `ewtpy`; the `Operator`
261
+ package supplies the Daubechies transition functions.
262
+ - New `Utils.Slepian` (DPSS / Slepian sequences) with three backends —
263
+ `scipy` (default), `C` (self-contained compiled core, loaded via `ctypes`)
264
+ and `numpy` — plus a bounded process-wide LRU cache; used by the EWT
265
+ `pre_deal="Slepian-Optimize"` multitaper branch.
266
+ - `Utils.FFT` gained a backend dispatcher (`numpy` / `scipy` / `pyfftw` /
267
+ `tiled` / `cupy`, with `auto` splitting on `BIG_ARRAY`); all backends
268
+ remain optional and fall back to numpy.
269
+ - **Remaining work for this line:** port `EEMD` / `CEEMDAN` off PyEMD
270
+ (tracked as the `0.3.x` scope above). Bug fixups are out of scope until
271
+ `0.4.0`.
272
+
216
273
  ### 0.2.1
217
274
 
218
275
  - `EMD` is now the native self-implemented sifting engine (ex-`EMD_new`,
@@ -21,6 +21,7 @@ algorithms (or benchmarking them against each other) is a one-line change.
21
21
  | EFD | Empirical Fourier Decomposition | `Function.EFD(S)` | [10.1016/j.ymssp.2021.108155](https://www.sciencedirect.com/science/article/abs/pii/S0888327021005355?via%3Dihub) |
22
22
  | EMD | Empirical Mode Decomposition | `Function.EMD(S)` | [10.1098/rspa.1998.0193](https://www.semanticscholar.org/paper/The-empirical-mode-decomposition-and-the-Hilbert-Huang-Shen/3842d81b0375dae8ae92734aa2a5d4aeed7a91d1) |
23
23
  | EWT | Empirical Wavelet Transform | `Function.EWT(S)` | [10.48550/arXiv.2304.06274](https://arxiv.org/abs/2304.06274) |
24
+ | EWTpy | Empirical Wavelet Transform (optional `ewtpy` backend) | `Function.EWTpy(S)` | [10.48550/arXiv.2304.06274](https://arxiv.org/abs/2304.06274) |
24
25
  | FMD | Filtered Mode Decomposition | `Function.FMD(S)` | [10.1109/TIE.2022.3156156](https://ieeexplore.ieee.org/document/9732251) |
25
26
  | ICEEMDAN | Improved Complete Ensemble Empirical Mode Decomposition with Adaptive Noise | `Function.ICEEMDAN(S)` | [10.1007/s10470-021-01901-3](https://link.springer.com/article/10.1007/s10470-021-01901-3#citeas) |
26
27
  | LMD | Local Mean Decomposition | `Function.LMD(S)` | [10.1098/rsif.2005.0058](https://royalsocietypublishing.org/doi/10.1098/rsif.2005.0058) |
@@ -64,18 +65,41 @@ Requires **Python >= 3.10**.
64
65
  |-------------|-----------------------------------------------------|
65
66
  | numpy | core arrays and vectorized kernels |
66
67
  | scipy | splines, envelope / Hilbert, filtering, peaks, FFT |
67
- | EMD-signal (PyEMD) | EMD, EEMD, CEEMDAN (and ensemble chains) |
68
- | ewtpy | EWT |
69
- | vmdpy | VMD |
68
+ | EMD-signal (PyEMD) | **EEMD and CEEMDAN only** — the last remaining third-party decomposition dependency |
70
69
  | psutil | available-memory reading for the memmap policy |
71
70
 
72
71
  > Please install `EMD-signal`, not `PyEMD` (the latter is an unrelated older package).
73
72
 
73
+ **PyEMD is the only third-party decomposition backend left.** Every other
74
+ method — `EMD`, `CEEMD`, `ICEEMDAN`, `RPSEMD`, `VMD`, `EWT`, `LMD`, `FMD`,
75
+ `EFD`, `CEEFD`, `SSA`, `SVMD`, `MEMD` — is implemented inside this library and
76
+ needs nothing beyond numpy/scipy. Only `EEMD` and `CEEMDAN` still delegate to
77
+ PyEMD, and **that dependency is being removed**: the `0.3.x` line exists
78
+ precisely to finish porting those two remaining branches, after which the
79
+ library stands on its own (see [Roadmap](#roadmap)).
80
+
81
+ `vmdpy` and `ewtpy` are **not** required: the native `VMD` / `EWT` replace them
82
+ entirely. `vmdpy` survives only as an optional parity-check backend
83
+ (`Class.VMD(vmdpy=True)`) and `EWTpy` / `ewtpy` only as an optional
84
+ reference-implementation adapter. Both are imported lazily, so neither is a
85
+ runtime dependency.
86
+
87
+ `EWT` (Empirical Wavelet Transform) is implemented **inside this library** and
88
+ needs no third-party package. The ewtpy-backed variant `EWTpy` is **optional**:
89
+ `ewtpy` is imported lazily (via `cache.import_module`) only when you actually
90
+ call `Function.EWTpy` / `Class.EWTpy(...).decompose(...)`, so a missing `ewtpy`
91
+ never affects the rest of the library — install it with
92
+ `pip install Modal-Decomposition[ewtpy]` (or plain `pip install ewtpy`) if you
93
+ want that entry.
94
+
74
95
  Optional extras (not required at runtime): `[dev]` (pytest, black) and
75
96
  `[plot]` (matplotlib). `numba` may be installed to activate the optional
76
97
  `"numba"` backend of `Utils.Peaks` / `SVMD`; everything degrades gracefully
77
98
  without it.
78
99
 
100
+ Accessing any method other than `EEMD` / `CEEMDAN` therefore never triggers a
101
+ PyEMD import at all — `EMD` in particular is the native sifting engine.
102
+
79
103
  ## Quick Start
80
104
 
81
105
  ```python
@@ -169,19 +193,55 @@ src/Modal_Decomposition/
169
193
  ├── __init__.py Class / Function namespaces + global API
170
194
  ├── <METHOD>.py 1 Config dataclass + 1 Decomposer per method
171
195
  ├── EMD.py native EMD engine (PyEMD-free; original EMD_new,
172
- │ registered as the public "EMD")
196
+ │ registered as the public "EMD"). Only EEMD / CEEMDAN
197
+ │ still reach PyEMD; the 0.3.x line removes that too
173
198
  ├── _Registry.py class registry (registration at import time)
174
199
  ├── Base/ Decomposer ABC, DecompositionResult, Config,
175
200
  │ import Cache, metadata tables, size constants
176
201
  └── Utils/ Check / Chunk / Peaks / Mirror / Spline / Envelope /
177
- Hilbert / Monotonicity / Memory / Seed
178
- (+ _Hilbert FHT backends)
202
+ Hilbert / Monotonicity / Memory / Seed / FFT / Slepian
203
+ (+ _Hilbert FHT and _Slepian C backends)
179
204
  tests/ pytest suite + benchmarking harnesses (comparison/,
180
205
  ssa/, test_memory/) against PyEMD and PySDKit
181
206
  ```
182
207
 
208
+ ## Roadmap
209
+
210
+ **`0.3.0` is the current release.** PyEMD is the only third-party
211
+ decomposition backend still in use, and it is on the way out; the version
212
+ plan splits the remaining work into two lines:
213
+
214
+ | Line | Scope |
215
+ |------|-------|
216
+ | **`0.3.x`** | **Finish removing PyEMD.** Port the two remaining PyEMD-backed branches (`EEMD`, `CEEMDAN`) onto the native engine, so the whole package runs on numpy/scipy alone. Nothing else is planned for this line — bug fixups are deliberately deferred. |
217
+ | **`0.4.0`** | **First fully self-developed release.** With every method native, this line takes on the remaining bug fixups and correctness work across the library. |
218
+
183
219
  ## Changelog
184
220
 
221
+ ### 0.3.0
222
+
223
+ - **Version line opened.** PyEMD is now the *only* third-party decomposition
224
+ dependency: `EEMD` and `CEEMDAN` are the sole methods still backed by it,
225
+ and removing that dependency is the entire scope of the `0.3.x` line.
226
+ Everything else — `EMD`, `CEEMD`, `ICEEMDAN`, `RPSEMD`, `VMD`, `EWT`,
227
+ `LMD`, `FMD`, `EFD`, `CEEFD`, `SSA`, `SVMD`, `MEMD` — is already native.
228
+ - `vmdpy` and `ewtpy` are demoted to optional parity-check / reference
229
+ backends (`Class.VMD(vmdpy=True)`, `Class.EWTpy`), no longer runtime
230
+ dependencies of `VMD` / `EWT`.
231
+ - `EWT` is fully re-implemented in-library (boundary detection, filter bank,
232
+ transform and inverse) and no longer requires `ewtpy`; the `Operator`
233
+ package supplies the Daubechies transition functions.
234
+ - New `Utils.Slepian` (DPSS / Slepian sequences) with three backends —
235
+ `scipy` (default), `C` (self-contained compiled core, loaded via `ctypes`)
236
+ and `numpy` — plus a bounded process-wide LRU cache; used by the EWT
237
+ `pre_deal="Slepian-Optimize"` multitaper branch.
238
+ - `Utils.FFT` gained a backend dispatcher (`numpy` / `scipy` / `pyfftw` /
239
+ `tiled` / `cupy`, with `auto` splitting on `BIG_ARRAY`); all backends
240
+ remain optional and fall back to numpy.
241
+ - **Remaining work for this line:** port `EEMD` / `CEEMDAN` off PyEMD
242
+ (tracked as the `0.3.x` scope above). Bug fixups are out of scope until
243
+ `0.4.0`.
244
+
185
245
  ### 0.2.1
186
246
 
187
247
  - `EMD` is now the native self-implemented sifting engine (ex-`EMD_new`,
@@ -1,10 +1,10 @@
1
1
  [build-system]
2
- requires = ["setuptools>=68.2.0", "wheel", "Cython>=3.0", "numpy>=1.21"]
2
+ requires = ["setuptools>=68.2.0", "wheel", "Cython>=3.0", "numpy>=1.21", "scipy>=1.15.3"]
3
3
  build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "Modal-Decomposition"
7
- version = "0.2.1"
7
+ version = "0.5.0"
8
8
  requires-python = ">=3.10"
9
9
 
10
10
  authors = [
@@ -26,14 +26,11 @@ classifiers = [
26
26
  ]
27
27
  dependencies = [
28
28
  "numpy",
29
- "EMD-signal",
30
- "ewtpy",
31
- "scipy",
32
- "vmdpy",
33
- "psutil"
29
+ "psutil",
30
+ "scipy"
34
31
  ]
35
32
 
36
- optional-dependencies = {"dev"=["pytest>=7.0", "black"], "plot"=["matplotlib"]}
33
+ optional-dependencies = {"cupy"=["cupy-cuda12x"], "pyfftw"=["pyfftw"]}
37
34
 
38
35
  [project.urls]
39
36
  homepage = "https://github.com/a-raining-day/Modal-Decomposition"
@@ -22,6 +22,26 @@ from setuptools.command.build_ext import build_ext as _build_ext
22
22
 
23
23
  _FHT_DIR = "src/Modal_Decomposition/Utils/_Hilbert"
24
24
  _FHT_C_DIR = _FHT_DIR + "/_C/_fht"
25
+ _SLEPIAN_C_DIR = "src/Modal_Decomposition/Utils/_Slepian/_C"
26
+
27
+
28
+ def _slepian_extension() -> Extension:
29
+ """_slepian_native: Slepian(DPSS) 的 C 核心 (三对角 + 对称折半 + 二分/反迭代)。
30
+
31
+ 纯 C (不引用 Python API), 由 ``Utils/_Slepian/C.py`` 用 ctypes 装载; 找不到时
32
+ ``Utils.Slepian`` 自动降级到 numpy 后端, 故同样是可选加速而非必需依赖。
33
+ MSVC 需 ``/utf-8``: 源码注释含中文, 否则按本地代码页(如 GBK)解析会产生告警。
34
+ """
35
+ if sys.platform == "win32":
36
+ compile_args = ["/O2", "/utf-8"]
37
+ else:
38
+ compile_args = ["-O3", "-std=c99"]
39
+ return Extension(
40
+ "Modal_Decomposition.Utils._Slepian._C._slepian_native",
41
+ sources=[_SLEPIAN_C_DIR + "/slepian_core.c"],
42
+ include_dirs=[_SLEPIAN_C_DIR],
43
+ extra_compile_args=compile_args,
44
+ )
25
45
 
26
46
 
27
47
  def _native_extension() -> Extension:
@@ -66,6 +86,6 @@ class _LazyCythonBuildExt(_build_ext):
66
86
 
67
87
 
68
88
  setup(
69
- ext_modules=[_native_extension()],
89
+ ext_modules=[_native_extension(), _slepian_extension()],
70
90
  cmdclass={"build_ext": _LazyCythonBuildExt},
71
91
  )
@@ -0,0 +1,73 @@
1
+ import os
2
+
3
+ from ..Define import PYTHON_VERSION, DEFAULT_ALLOCABLE_CPU_RATIO
4
+
5
+ __all__ = ["cpu_num", "allocable_cpu_num", "total_cpu", "set_allocable"]
6
+
7
+ cpu_num = None
8
+ allocable_cpu_num = None
9
+
10
+
11
+ def total_cpu() -> int:
12
+ """
13
+ 本机可用逻辑 CPU 数 (至少 1)
14
+
15
+ 如版本 >= 3.13, 则使用 os.process_cpu_count, 否则 os.cpu_count()
16
+ """
17
+ global cpu_num
18
+ if cpu_num is None:
19
+ if PYTHON_VERSION.major == 3 and PYTHON_VERSION.minor >= 13:
20
+ try:
21
+ cpu_num = os.process_cpu_count()
22
+ except Exception:
23
+ cpu_num = None
24
+
25
+ if cpu_num is None:
26
+ cpu_num = os.cpu_count()
27
+
28
+ return cpu_num
29
+
30
+ def set_allocable(value: int | float) -> int:
31
+ """
32
+ set allocable_cpu_num.
33
+ int means cpu num, [1, total];
34
+ float means cpu ratio, (0, 1];
35
+ -1 means all.
36
+ :param value:
37
+ :return:
38
+ """
39
+ global cpu_num, allocable_cpu_num
40
+
41
+ if isinstance(value, bool):
42
+ raise TypeError(f"value must be int or float, got {value!r}")
43
+
44
+ if isinstance(value, int):
45
+ # 整数是绝对核数:取值 0 < value <= cpu_num;-1 是"全部"哨兵,等价于 cpu_num。
46
+ if value == -1:
47
+ allocable_cpu_num = cpu_num
48
+ return allocable_cpu_num
49
+
50
+ if value <= 0 or value > cpu_num:
51
+ raise ValueError(f"num of value must in (0, {cpu_num})]")
52
+
53
+ allocable_cpu_num = value
54
+ return allocable_cpu_num
55
+
56
+ if isinstance(value, float):
57
+ if not (0.0 < value <= 1.0):
58
+ raise ValueError(f"ratio of value must in (0, 1], got {value!r}")
59
+
60
+ allocable_cpu_num = int(cpu_num * value)
61
+ if allocable_cpu_num < 1:
62
+ allocable_cpu_num = 1
63
+
64
+ allocable_cpu_num = allocable_cpu_num
65
+ return allocable_cpu_num
66
+
67
+ raise TypeError(f"value must be int or float, got {type(value)!r}")
68
+
69
+ if cpu_num is None:
70
+ total_cpu()
71
+
72
+ if allocable_cpu_num is None:
73
+ allocable_cpu_num = set_allocable(DEFAULT_ALLOCABLE_CPU_RATIO)