Split from xclim

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/Ouranosinc/cookiecutter-pypackage",
-  "commit": "1d9ee5f08d3e8e4f78a4aabb75e2ce4eff8750bf",
+  "commit": "f750ad2185cbb56df6f7e98a269bdd8399283ea8",
   "checkout": null,
   "context": {
     "cookiecutter": {

.flake8

@@ -12,6 +12,9 @@ ignore =
 	F,
 	W503
 per-file-ignores =
+rst-directives =
+	bibliography,
+	autolink-skip
 rst-roles =
 	doc,
 	mod,
@@ -25,3 +28,8 @@ rst-roles =
 	py:mod,
 	py:obj,
 	py:ref
+	ref,
+	cite:cts,
+	cite:p,
+	cite:t,
+	cite:ts

.github/workflows/main.yml

@@ -56,12 +56,10 @@ jobs:
       matrix:
         os: [ 'ubuntu-latest' ]
         python-version:
-          - "3.8"
-          - "3.9"
           - "3.10"
           - "3.11"
           - "3.12"
-          # - "3.13.0-rc.2"
+          # - "3.13"
     steps:
       - name: Harden Runner
         uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
@@ -84,7 +82,7 @@ jobs:
           key: ${{ matrix.os }}-Python${{ matrix.python-version }}-${{ hashFiles('pyproject.toml', 'tox.ini') }}
       - name: Test with tox
         run: |
-          python -m tox
+          python -m tox -e ${{ matrix.python-version }}-coveralls
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COVERALLS_FLAG_NAME: run-${{ matrix.python-version }}
@@ -98,7 +96,7 @@ jobs:
     strategy:
       matrix:
         os: [ 'ubuntu-latest' ]
-        python-version: [ "3.9", "3.10", "3.11", "3.12" ]
+        python-version: [ "3.10", "3.11", "3.12" ]
     defaults:
       run:
         shell: bash -l {0}
@@ -118,6 +116,11 @@ jobs:
           create-args: >-
             python=${{ matrix.python-version }}
           micromamba-version: "1.5.10-0"  # pinned to avoid the breaking changes with mamba and micromamba (2.0.0).
+      - name: Install xclim development version
+        # FIXME: This is a workaround to install xclim v0.53, which is not released.
+        run: |
+          echo "Installing xclim from main branch until version 0.53.0+ is released"
+          python -m pip install git+https://github.com/Ouranosinc/xclim.git@main
       - name: Install xsdba
         run: |
           python -m pip install --no-deps .

.github/workflows/publish-pypi.yml

@@ -26,6 +26,7 @@ jobs:
             files.pythonhosted.org:443
             github.com:443
             pypi.org:443
+            ruf-repo-cdn.sigstore.dev:443
             upload.pypi.org:443
       - name: Checkout Repository
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

.github/workflows/tag-testpypi.yml

@@ -50,6 +50,7 @@ jobs:
             files.pythonhosted.org:443
             github.com:443
             pypi.org:443
+            ruf-repo-cdn.sigstore.dev:443
             test.pypi.org:443
       - name: Checkout Repository
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

.pre-commit-config.yaml

@@ -46,7 +46,7 @@ repos:
     hooks:
       - id: ruff
         args: [ '--fix' ]
-      - id: ruff-format
+#      - id: ruff-format
   - repo: https://github.com/pycqa/flake8
     rev: 7.1.1
     hooks:

.zenodo.json

@@ -5,6 +5,11 @@
       "name": "Smith, Trevor James",
       "affiliation": "Ouranos, Montréal, Québec, Canada",
       "orcid": "0000-0001-5393-8359"
+    },
+    {
+      "name": "Dupuis, Éric",
+      "affiliation": "Ouranos, Montréal, Québec, Canada",
+      "orcid": "0000-0001-7976-4596"
     }
   ],
   "keywords": [

AUTHORS.rst

@@ -5,12 +5,13 @@ Credits
 Development Lead
 ----------------
 
-* Trevor James Smith <smith.trevorj@ouranos.ca> `@Zeitsperre <https://github.com/Zeitsperre>`_
+* Éric Dupuis <dupuis.eric@ouranos.ca> `@coxipi <https://github.com/coxipi>`_
 
 Co-Developers
 -------------
 
-None yet. Why not be the first?
+* Pascal Bourgault <[email protected]> `@aulemahal <https://github.com/aulemahal>`_
+* Trevor James Smith <[email protected]> `@Zeitsperre <https://github.com/Zeitsperre>`_
 
 Contributors
 ------------

CHANGELOG.rst

@@ -5,22 +5,20 @@ Changelog
 `Unreleased <https://github.com/Ouranosinc/xsdba>`_ (latest)
 ------------------------------------------------------------
 
-Contributors:
+Contributors: Éric Dupuis (:user:`coxipi`), Trevor James Smith (:user:`Zeitsperre`).
 
 Changes
 ^^^^^^^
-* No change.
+* Split `sdba` from `xclim` and duplicate code where needed. (:pull:`8`)
+* `units` are a copy (or almost) of given modules in `xclim`. A lot of duplicated code from xclim's `calendar` is also in xsdba's `base`. (:pull:`8`)
 
-Fixes
-^^^^^
-* No change.
 
 .. _changes_0.1.0:
 
 `v0.1.0 <https://github.com/Ouranosinc/xsdba/tree/0.1.0>`_
 ----------------------------------------------------------
 
-Contributors: Trevor James Smith (:user:`Ouranosinc`)
+Contributors: Trevor James Smith (:user:`Zeitsperre`)
 
 Changes
 ^^^^^^^

CI/requirements_ci.in

@@ -1,6 +1,6 @@
 bump-my-version==0.28.0
 coveralls==4.0.1
 pip==24.3.1
-flit==3.10.1
+flit==3.9.0
 tox==4.23.2
-tox-gh==1.4.1
+tox-gh==1.4.4

CI/requirements_ci.txt

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with Python 3.8
+# This file is autogenerated by pip-compile with Python 3.9
 # by the following command:
 #
 #    pip-compile --generate-hashes --output-file=CI/requirements_ci.txt CI/requirements_ci.in
@@ -399,27 +399,25 @@ tox==4.23.2 \
     # via
     #   -r CI/requirements_ci.in
     #   tox-gh
-tox-gh==1.4.1 \
-    --hash=sha256:005b33d16eef1bd1dae9f7d8b3cef53374af7d475f9c9c33ef098247741fb694 \
-    --hash=sha256:da422beccbdc5ad5994fe8faf6c193f2d794e957628b052ba23e7fcf9e2e340f
+tox-gh==1.4.4 \
+    --hash=sha256:4ea585f66585b90f5826b1677cfc9453747792a0f9ff83d468603bc17556e07b \
+    --hash=sha256:b962e0f8c4619e98d11c2a135939876691e148b843b7dac4cff7de1dc4f7c215
     # via -r CI/requirements_ci.in
 typing-extensions==4.12.2 \
     --hash=sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d \
     --hash=sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8
     # via
-    #   annotated-types
     #   pydantic
     #   pydantic-core
-    #   rich
     #   rich-click
     #   tox
 urllib3==2.2.2 \
     --hash=sha256:a448b2f64d686155468037e1ace9f2d2199776e17f0a46610480d311f73e3472 \
     --hash=sha256:dd505485549a7a552833da5e6063639d0d177c04f23bc3864e41e5dc5f612168
     # via requests
-virtualenv==20.26.6 \
-    --hash=sha256:280aede09a2a5c317e409a00102e7077c6432c5a38f0ef938e643805a7ad2c48 \
-    --hash=sha256:7345cc5b25405607a624d8418154577459c3e0277f5466dd79c49d5e492995f2
+virtualenv==20.27.1 \
+    --hash=sha256:142c6be10212543b32c6c45d3d3893dff89112cc588b7d0879ae5a1ec03a47ba \
+    --hash=sha256:f11f1b8a29525562925f745563bfd48b189450f61fb34c4f9cc79dd5aa32a1f4
     # via tox
 wcmatch==8.5.2 \
     --hash=sha256:17d3ad3758f9d0b5b4dedc770b65420d4dac62e680229c287bf24c9db856a478 \

README.rst

@@ -37,6 +37,11 @@ This package was created with Cookiecutter_ and the `Ouranosinc/cookiecutter-pyp
         :target: https://github.com/psf/black
         :alt: Python Black
 
+.. |logo| image:: https://raw.githubusercontent.com/Ouranosinc/xsdba/main/docs/logos/xsdba-logo-small-light.png
+        :target: https://github.com/Ouranosinc/xsdba
+        :alt: Xsdba
+        :class: xsdba-logo-small no-theme
+
 .. |build| image:: https://github.com/Ouranosinc/xsdba/actions/workflows/main.yml/badge.svg
         :target: https://github.com/Ouranosinc/xsdba/actions
         :alt: Build Status

docs/api.rst

@@ -0,0 +1,81 @@
+===
+API
+===
+
+.. _xsdba-user-api:
+
+xsdba Module
+============
+
+.. automodule:: xsdba.adjustment
+   :members:
+   :exclude-members: BaseAdjustment
+   :special-members:
+   :show-inheritance:
+   :noindex:
+
+.. automodule:: xsdba.processing
+   :members:
+   :noindex:
+
+.. automodule:: xsdba.detrending
+   :members:
+   :show-inheritance:
+   :exclude-members: BaseDetrend
+   :noindex:
+
+.. automodule:: xsdba.utils
+   :members:
+   :noindex:
+
+.. autoclass:: xsdba.base.Grouper
+   :members:
+   :class-doc-from: init
+   :noindex:
+
+.. automodule:: xsdba.nbutils
+   :members:
+   :noindex:
+
+.. automodule:: xsdba.loess
+   :members:
+   :noindex:
+
+.. automodule:: xsdba.properties
+   :members:
+   :exclude-members: StatisticalProperty
+   :noindex:
+
+.. automodule:: xsdba.measures
+   :members:
+   :exclude-members: StatisticalMeasure
+   :noindex:
+
+.. _`xsdba-developer-api`:
+
+xsdba Utilities
+---------------
+
+.. automodule:: xsdba.base
+   :members:
+   :show-inheritance:
+   :exclude-members: Grouper
+   :noindex:
+
+.. autoclass:: xsdba.detrending.BaseDetrend
+   :members:
+   :noindex:
+
+.. autoclass:: xsdba.adjustment.TrainAdjust
+   :members:
+   :noindex:
+
+.. autoclass:: xsdba.adjustment.Adjust
+   :members:
+   :noindex:
+
+.. autofunction:: xsdba.properties.StatisticalProperty
+   :noindex:
+
+.. autofunction:: xsdba.measures.StatisticalMeasure
+   :noindex: