:orphan:

EMD Tutorials
=============
.. image:: https://mybinder.org/badge_logo.svg
 :target: https://mybinder.org/v2/gl/emd-dev%2Femd/HEAD?filepath=doc%2Fsource%2F_notebooks

Guides to help get you started with data analysis using the EMD toolbox.

* Download all tutorials as :download:`Python files<../emd_tutorials/emd_tutorials_python.zip>` or :download:`Jupyter notebooks<../emd_tutorials/emd_tutorials_jupyter.zip>`. Individual tutorials can be downloaded from their respective pages.

* Launch the tutorials as interactive notebooks running on a cloud server using the Binder link above.

See the `Installation Instructions <../install.html>`_ for details on getting started running your analysis. To get started with these tutrials, you can download a tutorial-specific :download:`conda environment<https://gitlab.com/emd-dev/emd/-/blob/master/envs/emd_tutorial_conda_env.yml>`.



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    </div>




.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Quick-Start: Running a simple EMD">

.. only:: html

  .. image:: /emd_tutorials/00_quick_start/images/thumb/sphx_glr_emd_tutorial_00_start_01_quicksift_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_00_quick_start_emd_tutorial_00_start_01_quicksift.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Quick-Start: Running a simple EMD</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Why use EMD?">

.. only:: html

  .. image:: /emd_tutorials/00_quick_start/images/thumb/sphx_glr_emd_tutorial_00_start_02_whyemd_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_00_quick_start_emd_tutorial_00_start_02_whyemd.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Why use EMD?</div>
    </div>


.. raw:: html

    </div>

Sifting
=======

How to use and configure the different versions of the sift algorithm.



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Intro to the sift">

.. only:: html

  .. image:: /emd_tutorials/01_sifting/images/thumb/sphx_glr_emd_tutorial_01_sift_01_siftintro_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_01_sifting_emd_tutorial_01_sift_01_siftintro.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Intro to the sift</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="We will take a look at each of these steps in turn using a simulated time-series.">

.. only:: html

  .. image:: /emd_tutorials/01_sifting/images/thumb/sphx_glr_emd_tutorial_01_sift_02_siftindetail_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_01_sifting_emd_tutorial_01_sift_02_siftindetail.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">The sift in detail</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Ensemble sifting">

.. only:: html

  .. image:: /emd_tutorials/01_sifting/images/thumb/sphx_glr_emd_tutorial_01_sift_03_ensemblesift_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_01_sifting_emd_tutorial_01_sift_03_ensemblesift.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Ensemble sifting</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Masked sifting">

.. only:: html

  .. image:: /emd_tutorials/01_sifting/images/thumb/sphx_glr_emd_tutorial_01_sift_04_masksift_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_01_sifting_emd_tutorial_01_sift_04_masksift.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Masked sifting</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This tutorial introduces iterated masking EMD (itEMD), a recent sifting method that automates m...">

.. only:: html

  .. image:: /emd_tutorials/01_sifting/images/thumb/sphx_glr_emd_tutorial_01_sift_05_iterated_masksift_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_01_sifting_emd_tutorial_01_sift_05_iterated_masksift.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Iterated Masked sifting</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="SiftConfig Specification">

.. only:: html

  .. image:: /emd_tutorials/01_sifting/images/thumb/sphx_glr_emd_tutorial_01_sift_06_siftconfig_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_01_sifting_emd_tutorial_01_sift_06_siftconfig.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">SiftConfig Specification</div>
    </div>


.. raw:: html

    </div>

Spectrum Analysis
=================

Introduction to Instantaneous frequency estimation, the Hilbert-Huang transform and the Holospectrum.



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The Hilbert-Huang Transform">

.. only:: html

  .. image:: /emd_tutorials/02_spectrum_analysis/images/thumb/sphx_glr_emd_tutorial_02_spectrum_01_hilberthuang_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_02_spectrum_analysis_emd_tutorial_02_spectrum_01_hilberthuang.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">The Hilbert-Huang Transform</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The Holospectrum">

.. only:: html

  .. image:: /emd_tutorials/02_spectrum_analysis/images/thumb/sphx_glr_emd_tutorial_02_spectrum_02_holospectrum_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_02_spectrum_analysis_emd_tutorial_02_spectrum_02_holospectrum.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">The Holospectrum</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Cross-Frequency Coupling">

.. only:: html

  .. image:: /emd_tutorials/02_spectrum_analysis/images/thumb/sphx_glr_emd_tutorial_02_spectrum_03_crossfrequency_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_02_spectrum_analysis_emd_tutorial_02_spectrum_03_crossfrequency.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Cross-Frequency Coupling</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This tutorial accompanies the following paper which contains a more mathematical exposition of ...">

.. only:: html

  .. image:: /emd_tutorials/02_spectrum_analysis/images/thumb/sphx_glr_emd_tutorial_02_spectrum_04_harmonic_structures_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_02_spectrum_analysis_emd_tutorial_02_spectrum_04_harmonic_structures.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Understanding Harmonic Structures</div>
    </div>


.. raw:: html

    </div>

Cycle Analysis
==============

How to find and analyse the features of single cycles within Intrinsic Mode Functions.



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Cycle detection from IMFs">

.. only:: html

  .. image:: /emd_tutorials/03_cycle_ananlysis/images/thumb/sphx_glr_emd_tutorial_03_cycle_01_detect_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_03_cycle_ananlysis_emd_tutorial_03_cycle_01_detect.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Cycle detection from IMFs</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Cycle statistics and comparisons">

.. only:: html

  .. image:: /emd_tutorials/03_cycle_ananlysis/images/thumb/sphx_glr_emd_tutorial_03_cycle_02_statistics_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_03_cycle_ananlysis_emd_tutorial_03_cycle_02_statistics.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Cycle statistics and comparisons</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The &#x27;Cycles&#x27; class">

.. only:: html

  .. image:: /emd_tutorials/03_cycle_ananlysis/images/thumb/sphx_glr_emd_tutorial_03_cycle_03_cycleclass_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_03_cycle_ananlysis_emd_tutorial_03_cycle_03_cycleclass.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">The 'Cycles' class</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Waveform shape &amp; Instantaneous Frequency">

.. only:: html

  .. image:: /emd_tutorials/03_cycle_ananlysis/images/thumb/sphx_glr_emd_tutorial_03_cycle_04_waveform_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_03_cycle_ananlysis_emd_tutorial_03_cycle_04_waveform.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Waveform shape & Instantaneous Frequency</div>
    </div>


.. raw:: html

    </div>

Utilities
=========

Practical utility functions in the EMD package.



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Check install and run tests">

.. only:: html

  .. image:: /emd_tutorials/04_utilities/images/thumb/sphx_glr_emd_tutorial_04_utils_01_support_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_04_utilities_emd_tutorial_04_utils_01_support.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Check install and run tests</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Using the logger">

.. only:: html

  .. image:: /emd_tutorials/04_utilities/images/thumb/sphx_glr_emd_tutorial_04_utils_02_logger_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_04_utilities_emd_tutorial_04_utils_02_logger.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Using the logger</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Code speed and efficiency">

.. only:: html

  .. image:: /emd_tutorials/04_utilities/images/thumb/sphx_glr_emd_tutorial_04_utils_03_codespeed_thumb.png
    :alt:

  :ref:`sphx_glr_emd_tutorials_04_utilities_emd_tutorial_04_utils_03_codespeed.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Code speed and efficiency</div>
    </div>


.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /emd_tutorials/00_quick_start/index.rst
   /emd_tutorials/01_sifting/index.rst
   /emd_tutorials/02_spectrum_analysis/index.rst
   /emd_tutorials/03_cycle_ananlysis/index.rst
   /emd_tutorials/04_utilities/index.rst


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: emd_tutorials_python.zip </emd_tutorials/emd_tutorials_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: emd_tutorials_jupyter.zip </emd_tutorials/emd_tutorials_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_