.. pyeemd documentation master file, created by
   sphinx-quickstart on Wed Dec 18 10:01:27 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pyeemd's documentation!
==================================

This is the documentation of `pyeemd`, which is a Python wrapper for `libeemd`,
a C library for performing the ensemble empirical mode decomposition (EEMD),
its complete variant (CEEMDAN) or the regular empirical mode decomposition
(EMD).

If you have any questions or problems with `pyeemd`, or you wish to
propose enhancements, please check out the `main project website`_.

.. _main project website: https://bitbucket.org/luukko/pyeemd/

If you use pyeemd for scientific work please cite: (`link`__, `arXiv`_)

    Luukko, P. J. J., Helske, J. & Räsänen, E., Comput. Stat. **31**, 545 (2016)

This article also describes in detail what libeemd actually
computes. You should definitely read it if you are unsure about what EMD, EEMD
and CEEMDAN are.

__ https://dx.doi.org/10.1007/s00180-015-0603-9
.. _arXiv: https://arxiv.org/abs/1707.00487

Contents:
---------

.. toctree::

   install
   tutorial
   pyeemd


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`