Skip to content

Commit

Permalink
Extend Readme with FAQ
Browse files Browse the repository at this point in the history
Minor version bump
  • Loading branch information
laszukdawid committed Apr 10, 2020
1 parent 9fb550f commit 1989b76
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 7 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 1989b76

Please sign in to comment.