.. _core_api:

Pyleoclim User API
===================

Pyleoclim, like a lot of other Python packages, follows an object-oriented design. It sounds fancy, but it really is `quite simple <https://www.freecodecamp.org/news/object-oriented-programming-concepts-21bb035f7260/>`_. What this means for you is that we've gone through the trouble of coding up a lot of timeseries analysis methods that apply in various situations - so you don't have to worry about that.
These situations are described in classes, the beauty of which is called "inheritance" (see link above). Basically, it allows to define methods that will automatically apply to your dataset, as long as you put your data within one of those classes.
A major advantage of object-oriented design is that you, the user, can harness the power of Pyleoclim methods in very few lines of code through the user API without ever having to get your hands dirty with our code (unless you want to, of course).
The flipside is that any user would do well to understand Pyleoclim classes, what they are intended for, and what methods they support.

.. image:: Pyleoclim_API_2.png
   :scale: 50 %
   :width: 1477px
   :height: 946px
   :alt: The Pyleoclim User API. Credit: Feng Zhu
   :align: center

The following describes the various classes that undergird the Pyleoclim edifice.

Series (pyleoclim.Series)
"""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.series.Series
   :members:

GeoSeries (pyleoclim.GeoSeries)
"""""""""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.geoseries.GeoSeries
   :members:


MultipleSeries (pyleoclim.MultipleSeries)
"""""""""""""""""""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.multipleseries.MultipleSeries
   :members:

MultipleGeoSeries (pyleoclim.MultipleGeoSeries)
"""""""""""""""""""""""""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.multiplegeoseries.MultipleGeoSeries
   :members:

EnsembleSeries (pyleoclim.EnsembleSeries)
"""""""""""""""""""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.ensembleseries.EnsembleSeries
   :members:

EnsembleGeoSeries (pyleoclim.EnsembleGeoSeries)
"""""""""""""""""""""""""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.ensemblegeoseries.EnsembleGeoSeries
   :members:

MulEnsGeoSeries (pyleoclim.MulEnsGeoSeries)
"""""""""""""""""""""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.mulensgeoseries.MulEnsGeoSeries
   :members:

SurrogateSeries (pyleoclim.SurrogateSeries)
"""""""""""""""""""""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.surrogateseries.SurrogateSeries
  :members:

PSD (pyleoclim.PSD)
"""""""""""""""""""

.. autoclass:: pyleoclim.core.psds.PSD
   :members:

MultiplePSD (pyleoclim.MultiplePSD)
"""""""""""""""""""""""""""""""""""

 .. autoclass:: pyleoclim.core.psds.MultiplePSD
    :members:

Scalogram (pyleoclim.Scalogram)
"""""""""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.scalograms.Scalogram
   :members:

MultipleScalogram (pyleoclim.MultipleScalogram)
"""""""""""""""""""""""""""""""""""""""""""""""
.. autoclass:: pyleoclim.core.scalograms.MultipleScalogram
   :members:

Coherence (pyleoclim.Coherence)
"""""""""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.coherences.Coherence
   :members:

GlobalCoherence (pyleoclim.GlobalCoherence)
"""""""""""""""""""""""""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.coherences.GlobalCoherence
   :members:

Corr (pyleoclim.Corr)
"""""""""""""""""""""

.. autoclass:: pyleoclim.core.corr.Corr
   :members:

CorrEns (pyleoclim.CorrEns)
"""""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.correns.CorrEns
   :members:

MultivarDecomp (pyleoclim.MultivariateDecomp)
"""""""""""""""""""""""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.multivardecomp.MultivariateDecomp
  :members:

EnsMultivarDecomp (pyleoclim.EnsMultivarDecomp)
"""""""""""""""""""""""""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.ensmultivardecomp.EnsMultivarDecomp
  :members:

SsaRes (pyleoclim.SsaRes)
"""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.ssares.SsaRes
   :members:

Resolution (pyleoclim.Resolution)
"""""""""""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.resolutions.Resolution
   :members:

MultipleResolution (pyleoclim.MultipleResolution)
"""""""""""""""""""""""""""""""""""""""""""""""""

.. autoclass:: pyleoclim.core.resolutions.MultipleResolution
   :members: