.. _utils_introduction:

Pyleoclim Utilities API (pyleoclim.utils)
=========================================

Utilities upon which Pyleoclim depends for higher-level functionalities accessible to users.

Pyleoclim makes extensive use of functions from `numpy <https://numpy.org>`_,
`Pandas <https://pandas.pydata.org>`_, `Scipy <https://www.scipy.org>`_, `Matplotlib <https://matplotlib.org>`_,
`Statsmodels <https://www.statsmodels.org/>`_, and `scikit-learn <https://scikit-learn.org/stable/>`_.
Please note that some default parameter values for these functions have been changed
to values more appropriate for paleoclimate datasets.

Causality
"""""""""
.. automodule:: pyleoclim.utils.causality
  :members:
  :ignore-module-all: True


Correlation
"""""""""""

.. automodule:: pyleoclim.utils.correlation
  :members:
  :ignore-module-all: True

Decomposition
"""""""""""""

.. automodule:: pyleoclim.utils.decomposition
  :members:
  :ignore-module-all: True

Filter
""""""

.. automodule:: pyleoclim.utils.filter
  :members:
  :ignore-module-all: True

Mapping
"""""""

.. automodule:: pyleoclim.utils.mapping
  :members:
  :ignore-module-all: True

Plotting
""""""""

.. automodule:: pyleoclim.utils.plotting
  :members:
  :ignore-module-all: True

Spectral
""""""""

.. automodule:: pyleoclim.utils.spectral
  :members:
  :ignore-module-all: True


Tsmodel
"""""""

.. automodule:: pyleoclim.utils.tsmodel
  :members:
  :ignore-module-all: True



Wavelet
"""""""

.. automodule:: pyleoclim.utils.wavelet
  :members:
  :ignore-module-all: True


Tsutils
"""""""

.. automodule:: pyleoclim.utils.tsutils
  :members:
  :ignore-module-all: True



Tsbase
""""""

.. automodule:: pyleoclim.utils.tsbase
  :members:
  :ignore-module-all: True



Lipdutils
"""""""""

.. automodule:: pyleoclim.utils.lipdutils
  :members:
  :ignore-module-all: True

jsonutils
"""""""""

.. automodule:: pyleoclim.utils.jsonutils
  :members:
  :ignore-module-all: True


Utilities for EMD decomposition
"""""""""""""""""""""""""""""""

.. automodule:: pyleoclim.utils.emd_utils
  :members:
  :ignore-module-all: True