Update docs

TUW-GEO · Jan 8, 2025 · 75bacee · 75bacee
1 parent 98dc169
commit 75bacee
Show file tree

Hide file tree

Showing 5 changed files with 86 additions and 68 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -18,10 +18,9 @@ jobs:
     strategy:
       matrix:
         # as we build C extension for users to download, we want to include as many python versions
-        # and OS versions as possible (especially windows to create .whl packages,
-        # see step "Create wheel and dist package")
+        # and OS versions as possible
         python-version: ['3.9', '3.10', '3.11', '3.12']
-        os: ["ubuntu-22.04", "windows-2022", "macos-14"]
+        os: ["ubuntu-latest", "windows-latest", "macos-latest"]
     name: py${{ matrix.python-version }}@${{ matrix.os }}
     runs-on: ${{ matrix.os }}
 

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -4,7 +4,8 @@ Changelog
 
 Unreleased changes in master
 ============================
--
+- `pytesmo.interpolate` module was added. This contains a python implementation of the DCT-PLS algorithm `(Garcia, 2010) <https://doi.org/10.1016/j.csda.2009.09.020>`_.
+  DCT-PLS docs and examples added (PR `#315 <https://github.com/TUW-GEO/pytesmo/pull/315>`_)
 
 Version 0.17.0, 2024-11-14
 ==========================

diff --git a/docs/examples/dct_pls.ipynb b/docs/examples/dct_pls.ipynb
diff --git a/docs/index.rst b/docs/index.rst
@@ -7,6 +7,8 @@
    README <readme>
    Introduction <introduction>
 
+   DCT-PLS algorithm <examples/dct_pls>
+
    Validation Framework <examples/validation_framework>
    Temporal Collocation <examples/temporal_collocation>
    Anomaly Computation <examples/anomalies>

diff --git a/environment.yml b/environment.yml
@@ -31,6 +31,7 @@ dependencies:
     - cadati>=0.0.2
     # optional, for documentation and testing:
     - nbconvert
+    - nbsphinx
     - ipykernel
     - sphinx_rtd_theme
     - ascat>=2.0