refactor!: reorganize methods into new namespaces (#210)

xarray-contrib · Sep 2, 2024 · 675983f · 675983f
1 parent 7505350
commit 675983f
Show file tree

Hide file tree

Showing 302 changed files with 4,951 additions and 3,059 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -16,7 +16,7 @@ Provide a concise Python code snippet that demonstrates the issue. To display th
 ```python
 import xeofs as xe
 
-model = xe.models.EOF()
+model = xe.single.EOF()
 ...
 ```
 

diff --git a/.github/ISSUE_TEMPLATE/how_to.md b/.github/ISSUE_TEMPLATE/how_to.md
@@ -16,7 +16,7 @@ Provide a concise Python code snippet that demonstrates your approach. To displa
 ```python
 import xeofs as xe
 
-model = xe.models.EOF()
+model = xe.single.EOF()
 ...
 ```
 

diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,7 @@
 # Personal
 .vscode/
 # Test related to CCA
-tests/models/test_cca_solution.py
+tests/**/test_cca_solution.py
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

diff --git a/README.md b/README.md
@@ -60,9 +60,9 @@ In order to get started with `xeofs`, follow these simple steps:
 Initiate and fit the EOF/PCA model to the data
 
 ```python
->>> eof = xe.models.EOF(n_modes=10)
+>>> eof = xe.single.EOF(n_modes=10)
 >>> eof.fit(t2m, dim="time")  # doctest: +ELLIPSIS
-<xeofs.models.eof.EOF object at ...>
+<xeofs.single.eof.EOF object at ...>
 
 ```
 Now, you can access the model's EOF components and PC scores:
@@ -77,9 +77,9 @@ Now, you can access the model's EOF components and PC scores:
 Initiate and fit an `EOFRotator` class to the model to obtain a varimax-rotated EOF analysis
 
 ```python
->>> rotator = xe.models.EOFRotator(n_modes=3)
+>>> rotator = xe.single.EOFRotator(n_modes=3)
 >>> rotator.fit(eof) # doctest: +ELLIPSIS
-<xeofs.models.eof_rotator.EOFRotator object at ...>
+<xeofs.single.eof_rotator.EOFRotator object at ...>
 
 >>> rot_comps = rotator.components()  # Rotated EOFs (spatial patterns)
 >>> rot_scores = rotator.scores()  # Rotated PCs (temporal patterns)
@@ -89,9 +89,9 @@ Initiate and fit an `EOFRotator` class to the model to obtain a varimax-rotated
 **Maximum Covariance Analysis (MCA)**
 
 ```python
->>> mca = xe.models.MCA(n_modes=10)
+>>> mca = xe.cross.MCA(n_modes=10)
 >>> mca.fit(t2m_west, t2m_east, dim="time")  # doctest: +ELLIPSIS
-<xeofs.models.mca.MCA object at ...>
+<xeofs.cross.mca.MCA object at ...>
 
 >>> comps1, comps2 = mca.components()  # Singular vectors (spatial patterns)
 >>> scores1, scores2 = mca.scores()  # Expansion coefficients (temporal patterns)
@@ -101,9 +101,9 @@ Initiate and fit an `EOFRotator` class to the model to obtain a varimax-rotated
 **Varimax-rotated MCA**
 
 ```python
->>> rotator = xe.models.MCARotator(n_modes=10)
+>>> rotator = xe.cross.MCARotator(n_modes=10)
 >>> rotator.fit(mca)  # doctest: +ELLIPSIS
-<xeofs.models.mca_rotator.MCARotator object at ...>
+<xeofs.cross.mca_rotator.MCARotator object at ...>
 
 >>> rot_comps = rotator.components()  # Rotated singular vectors (spatial patterns)
 >>> rot_scores = rotator.scores()  # Rotated expansion coefficients (temporal patterns)

diff --git a/xeofs/models/_np_classes/__init__.py → docs/__init__.py b/xeofs/models/_np_classes/__init__.py → docs/__init__.py
diff --git a/docs/_autosummary/xeofs.models.ComplexEOF.rst b/docs/_autosummary/xeofs.models.ComplexEOF.rst
diff --git a/docs/_autosummary/xeofs.models.ComplexEOFRotator.rst b/docs/_autosummary/xeofs.models.ComplexEOFRotator.rst
diff --git a/docs/_autosummary/xeofs.models.ComplexMCA.rst b/docs/_autosummary/xeofs.models.ComplexMCA.rst
diff --git a/docs/_autosummary/xeofs.models.ComplexMCARotator.rst b/docs/_autosummary/xeofs.models.ComplexMCARotator.rst
diff --git a/docs/_autosummary/xeofs.models.EOF.rst b/docs/_autosummary/xeofs.models.EOF.rst
diff --git a/docs/_autosummary/xeofs.models.EOFRotator.rst b/docs/_autosummary/xeofs.models.EOFRotator.rst
diff --git a/docs/_autosummary/xeofs.models.ExtendedEOF.rst b/docs/_autosummary/xeofs.models.ExtendedEOF.rst