feat: add Optimal Persistence Analysis (OPA)

xarray-contrib · Aug 14, 2023 · 2482110 · 2482110
1 parent bb8a0da
commit 2482110
Show file tree

Hide file tree

Showing 7 changed files with 738 additions and 0 deletions.
diff --git a/docs/_autosummary/xeofs.models.OPA.rst b/docs/_autosummary/xeofs.models.OPA.rst
@@ -0,0 +1,34 @@
+xeofs.models.OPA
+================
+
+.. currentmodule:: xeofs.models
+
+.. autoclass:: OPA
+   :members:
+   :show-inheritance: 
+   :inherited-members:
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~OPA.__init__
+      ~OPA.components
+      ~OPA.compute
+      ~OPA.decorrelation_time
+      ~OPA.filter_patterns
+      ~OPA.fit
+      ~OPA.get_params
+      ~OPA.inverse_transform
+      ~OPA.scores
+      ~OPA.transform
+
+
+
+
+
+
diff --git a/docs/api_core_methods.rst b/docs/api_core_methods.rst
@@ -6,4 +6,5 @@ Core methods
    :recursive:
 
    xeofs.models.EOF
+   xeofs.models.OPA
    xeofs.models.MCA
diff --git a/docs/models.rst b/docs/models.rst
@@ -26,6 +26,17 @@ The supported models in ``xeofs`` currently include:
       Uncovers co-varying patterns between two sets of data.
 
 
+.. grid:: 2
+
+    .. grid-item-card::  Optimal Persistence Analysis (OPA)
+      :link: api_core_methods
+      :link-type: doc
+
+
+      Identifies the optimal persistence patterns (OPP) with the largest decorrelation time.
+
+
+
 Enhanced Interpretability
 ---------------------------