diff --git a/README.md b/README.md index ab00dcd..72b5d46 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ intends to deliver more in time. * Ensemble EMD (EEMD), * "Complete Ensemble EMD" (CEEMDAN) * different settings and configurations of vanilla EMD. -* Image decomposition (EMD2D & BEMD) (experimental) +* Image decomposition (EMD2D & BEMD) (experimental, no support) *PyEMD* allows to use different splines for envelopes, stopping criteria and extrema interpolation. @@ -167,11 +167,18 @@ emd2d = EMD2D() # BEMD() also works IMFs_2D = emd2d(img) ``` +## F.A.Q + +### Why is EEMD/CEEMDAN so slow? +Unfortunately, that's their nature. They execute EMD multiple times every time with slightly modified version. Added noise can cause a creation of many extrema which will decrease performance of the natural cubic spline. For some tweaks on how to deal with that please see [Speedup tricks](https://pyemd.readthedocs.io/en/latest/speedup_eemd.html) in the documentation. + + + ## Contact -Feel free to contact me with any questions, requests or simply to say -*hi*. It's always nice to know that I one's work have eased others and saved -someone's time. Contributing to the project is also acceptable. +Feel free to contact me with any questions, requests or simply to say *hi*. +It's always nice to know that I've helped someone or made their work easier. +Contributing to the project is also acceptable and warmly welcomed. Contact me either through gmail (laszukdawid @ gmail) or search me through your favourite web search. diff --git a/doc/conf.py b/doc/conf.py index e8cdbe3..69ee6c8 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -72,9 +72,9 @@ # built documents. # # The short X.Y version. -version = u'0.2.8' +version = u'0.2.9' # The full version, including alpha/beta/rc tags. -release = u'0.2.8' +release = u'0.2.9' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/setup.py b/setup.py index 7607602..318ef06 100644 --- a/setup.py +++ b/setup.py @@ -30,7 +30,7 @@ def main(): long_description_content_type="text/markdown", url="https://github.com/laszukdawid/PyEMD", author="Dawid Laszuk", - author_email="dawid@lasz.uk", + author_email="pyemd@dawid.lasz.uk", license="Apache-2.0", classifiers=classifiers, keywords="signal decomposition data analysis",