PASSED: test_units.py (still needs more tests)

Author: coxipi

src/xsdba/detrending.py

@@ -9,7 +9,7 @@
 
 from .base import Grouper, ParametrizableWithDataset, map_groups, parse_group
 from .loess import loess_smoothing
-from .units import check_units
+from .units import compare_units
 from .utils import ADDITIVE, apply_correction, invert
 
 
@@ -91,13 +91,13 @@ def retrend(self, da: xr.DataArray):
             raise ValueError("You must call fit() before retrending")
         return self._retrend(da, self.ds.trend)
 
-    @check_units(["da", "trend"])
+    @compare_units(["da", "trend"])
     def _detrend(self, da, trend):
         """Detrend."""
         # Remove trend from series
         return apply_correction(da, invert(trend, self.kind), self.kind)
 
-    @check_units(["da", "trend"])
+    @compare_units(["da", "trend"])
     def _retrend(self, da, trend):
         """Retrend."""
         # Add trend to series

src/xsdba/indicator.py

@@ -106,6 +106,7 @@
 import warnings
 import weakref
 from collections import OrderedDict, defaultdict
+from collections.abc import Sequence
 from copy import deepcopy
 from dataclasses import asdict, dataclass
 from functools import reduce
@@ -117,7 +118,6 @@
 from pathlib import Path
 from types import ModuleType
 from typing import Any, Callable, Optional, Union
-from collections.abc import Sequence
 
 import numpy as np
 import xarray
@@ -156,7 +156,7 @@
     OPTIONS,
 )
 from .typing import InputKind
-from .units import check_units, convert_units_to, units
+from .units import compare_units, convert_units_to, units
 from .utils import load_module
 
 # Indicators registry
@@ -1149,7 +1149,7 @@ def _translate(cf_attrs, names, var_id=None):
         return attrs
 
     @classmethod
-    def json(self, args=None):
+    def json(cls, args=None):
         """Return a serializable dictionary representation of the class.
 
         Parameters

src/xsdba/measures.py

@@ -21,7 +21,7 @@
 # from xclim.core.units import ensure_delta
 from .base import Grouper
 from .typing import InputKind
-from .units import check_units, ensure_delta
+from .units import compare_units, ensure_delta
 from .utils import _pairwise_spearman
 
 
@@ -48,7 +48,7 @@ def _ensure_correct_parameters(cls, parameters):
             )
         return super()._ensure_correct_parameters(parameters)
 
-    @check_units([{"das": "ref"}, {"das": "sim"}])
+    @compare_units([{"das": "ref"}, {"das": "sim"}])
     def _preprocess_and_checks(self, das, params):
         """Perform parent's checks and also check convert units so that sim matches ref."""
         das, params = super()._preprocess_and_checks(das, params)
@@ -110,7 +110,7 @@ def _ensure_correct_parameters(cls, parameters):
 
         return super()._ensure_correct_parameters(parameters)
 
-    @check_units([{"das": "ref"}, {"das": "sim"}])
+    @compare_units([{"das": "ref"}, {"das": "sim"}])
     def _preprocess_and_checks(self, das, params):
         """Perform parent's checks and also check convert units so that sim matches ref."""
         das, params = super()._preprocess_and_checks(das, params)

src/xsdba/processing.py

@@ -20,7 +20,7 @@
 from ._processing import _adapt_freq, _normalize, _reordering
 from .base import Grouper
 from .nbutils import _escore
-from .units import check_units, convert_units_to, harmonize_units
+from .units import compare_units, convert_units_to, harmonize_units
 from .utils import ADDITIVE, copy_all_attrs
 
 # from xclim.core.units import convert_units_to, infer_context, units
@@ -67,7 +67,7 @@ def adapt_freq(
     sim : xr.Dataset
         Simulated data, with a "time" dimension.
     group : str or Grouper
-        Grouping information, see base.Grouper
+        Grouping information, see base.Grouper.
     thresh : str
         Threshold below which values are considered zero, a quantity with units.
 
@@ -96,7 +96,6 @@ def adapt_freq(
     References
     ----------
     :cite:cts:`sdba-themesl_empirical-statistical_2012`
-
     """
     out = _adapt_freq(xr.Dataset(dict(sim=sim, ref=ref)), group=group, thresh=thresh)
 
@@ -134,7 +133,7 @@ def jitter_under_thresh(x: xr.DataArray, thresh: str) -> xr.DataArray:
 
     Returns
     -------
-    xr.DataArray
+    xr.DataArray.
 
     Notes
     -----
@@ -162,12 +161,11 @@ def jitter_over_thresh(x: xr.DataArray, thresh: str, upper_bnd: str) -> xr.DataA
 
     Returns
     -------
-    xr.DataArray
+    xr.DataArray.
 
     Notes
     -----
     If thresh is low, this will change the mean value of x.
-
     """
     j: xr.DataArray = jitter(
         x, lower=None, upper=thresh, minimum=None, maximum=upper_bnd
@@ -353,29 +351,28 @@ def unstandardize(da: xr.DataArray, mean: xr.DataArray, std: xr.DataArray):
 
 @update_xsdba_history
 def reordering(ref: xr.DataArray, sim: xr.DataArray, group: str = "time") -> xr.Dataset:
-    """Reorders data in `sim` following the order of ref.
+    """Reorder data in `sim` following the order of ref.
 
     The rank structure of `ref` is used to reorder the elements of `sim` along dimension "time", optionally doing the
     operation group-wise.
 
     Parameters
     ----------
-    sim : xr.DataArray
-        Array to reorder.
     ref : xr.DataArray
         Array whose rank order sim should replicate.
+    sim : xr.DataArray
+        Array to reorder.
     group : str
         Grouping information. See :py:class:`xclim.sdba.base.Grouper` for details.
 
     Returns
     -------
     xr.Dataset
-        sim reordered according to ref's rank order.
+        Sim reordered according to ref's rank order.
 
     References
     ----------
-    :cite:cts:`sdba-cannon_multivariate_2018`
-
+    :cite:cts:`sdba-cannon_multivariate_2018`.
     """
     ds = xr.Dataset({"sim": sim, "ref": ref})
     out: xr.Dataset = _reordering(ds, group=group).reordered
@@ -414,7 +411,7 @@ def escore(
     Returns
     -------
     xr.DataArray
-        e-score with dimensions not in `dims`.
+        Return e-score with dimensions not in `dims`.
 
     Notes
     -----
@@ -441,8 +438,7 @@ def escore(
 
     References
     ----------
-    :cite:cts:`sdba-baringhaus_new_2004,sdba-cannon_multivariate_2018,sdba-cannon_mbc_2020,sdba-szekely_testing_2004`
-
+    :cite:cts:`sdba-baringhaus_new_2004,sdba-cannon_multivariate_2018,sdba-cannon_mbc_2020,sdba-szekely_testing_2004`.
     """
     pts_dim, obs_dim = dims
 
@@ -563,14 +559,14 @@ def to_additive_space(
 
     See Also
     --------
+    Related functions
     from_additive_space : for the inverse transformation.
     jitter_under_thresh : Remove values exactly equal to the lower bound.
     jitter_over_thresh : Remove values exactly equal to the upper bound.
 
     References
     ----------
-    :cite:cts:`sdba-alavoine_distinct_2022`
-
+    :cite:cts:`sdba-alavoine_distinct_2022`.
     """
     # with units.context(infer_context(data.attrs.get("standard_name"))):
     lower_bound_array = np.array(lower_bound).astype(float)
@@ -666,7 +662,7 @@ def from_additive_space(
 
     References
     ----------
-    :cite:cts:`sdba-alavoine_distinct_2022`
+    :cite:cts:`sdba-alavoine_distinct_2022`.
 
     """
     if trans is None and lower_bound is None and units is None:
@@ -748,7 +744,6 @@ def stack_variables(ds: xr.Dataset, rechunk: bool = True, dim: str = "multivar")
         `sdba_transform_upper` are also set if the requested bounds are different from the defaults.
 
         Array with variables stacked along `dim` dimension. Units are set to "".
-
     """
     # Store original arrays' attributes
     attrs: dict = {}
@@ -825,7 +820,7 @@ def grouped_time_indexes(times, group):
     times : xr.DataArray
         Time dimension in the dataset of interest.
     group : str or Grouper
-        Grouping information, see base.Grouper
+        Grouping information, see base.Grouper.
 
     Returns
     -------

src/xsdba/units.py

@@ -24,12 +24,13 @@
 import numpy as np
 import xarray as xr
 
-from .calendar import parse_offset
+from .calendar import get_calendar, parse_offset
 from .typing import Quantified
 from .utils import copy_all_attrs
 
 units = pint.get_application_registry()
-
+# Another alias not included by cf_xarray
+units.define("@alias percent = pct")
 
 FREQ_UNITS = {
     "D": "d",
@@ -66,7 +67,7 @@ def infer_sampling_units(
     Returns
     -------
     int
-        The magnitude (number of base periods per period)
+        The magnitude (number of base periods per period).
     str
         Units as a string, understandable by pint.
     """
@@ -169,7 +170,7 @@ def pint2str(value: units.Quantity | units.Unit) -> str:
     Returns
     -------
     str
-        Units
+        Units.
 
     Notes
     -----
@@ -213,7 +214,7 @@ def ensure_delta(unit: str) -> str:
     Parameters
     ----------
     unit : str
-        unit to transform in delta (or not)
+        unit to transform in delta (or not).
     """
     u = units2pint(unit)
     d = 1 * u
@@ -246,7 +247,7 @@ def extract_units(arg):
     return ustr if ustr is None else pint.Quantity(1, ustr).units
 
 
-def check_units(args_to_check):
+def compare_units(args_to_check):
     """Decorator to check that all arguments have the same units (or no units)."""
 
     # if no units are present (DataArray without units attribute or float), then no check is performed
@@ -312,14 +313,6 @@ def convert_units_to(  # noqa: C901
         The outputted type is always similar to `source` initial type.
         Attributes are preserved unless an automatic CF conversion is performed,
         in which case only the new `standard_name` appears in the result.
-
-    See Also
-    --------
-    cf_conversion
-    amount2rate
-    rate2amount
-    amount2lwethickness
-    lwethickness2amount
     """
     # Target units
     target_unit = extract_units(target)
@@ -346,6 +339,7 @@ def _add_default_kws(params_dict, params_to_check, func):
     return params_dict
 
 
+# TODO: this changes the type of some variables (e.g. thresh : str -> float). This should probably not be allowed
 def harmonize_units(params_to_check):
     """Check that units are compatible with dimensions, otherwise raise a `ValidationError`."""
 
@@ -460,7 +454,7 @@ def to_agg_units(
 
     >>> degdays = convert_units_to(degdays, "K days")
     >>> degdays.units
-    'K d'
+    'K d'.
     """
     if op in ["amin", "min", "amax", "max", "mean", "sum"]:
         out.attrs["units"] = orig.attrs["units"]