Dimensionless units as "1" - adapt to numpy 2

CHANGELOG.rst

@@ -4,7 +4,12 @@ Changelog
 
 v0.52.0 (unreleased)
 --------------------
-Contributors to this version: David Huard (:user:`huard`).
+Contributors to this version: David Huard (:user:`huard`), Pascal Bourgault (:user:`aulemahal`).
+
+Breaking changes
+^^^^^^^^^^^^^^^^
+* Dimensionless quantities now use the "1" units attribute as specified by the CF conventions, previously an empty string was returned. (:pull:`1814`).
+* Updated minimum versions for some dependencies: ``numpy>=2``, ``cf-xarray>=0.9.3`` and ``pint>=0.24.1``. (:pull:`1814`).
 
 Internal changes
 ^^^^^^^^^^^^^^^^

environment.yml

@@ -6,15 +6,15 @@ dependencies:
  - python >=3.9
  - boltons >=20.1
  - bottleneck >=1.3.1
- - cf_xarray >=0.6.1
+ - cf_xarray >=0.9.3
  - cftime >=1.4.1
  - click >=8.1
  - dask >=2.6.0
  - jsonpickle
  - numba
- - numpy >=1.20.0
+ - numpy >=2
  - pandas >=2.2.0
- - pint >=0.18
+ - pint >=0.24.1
  - poppler >=0.67
  - pyarrow # Strongly encouraged for Pandas v2.2.0+
  - pyyaml

tests/test_atmos.py

@@ -260,7 +260,7 @@ def test_wind_profile(atmosds):
 
 def test_wind_power_potential(atmosds):
  out = atmos.wind_power_potential(wind_speed=atmosds.sfcWind)
- assert out.attrs["units"] == ""
+ assert out.attrs["units"] == "1"
  assert (out >= 0).all()
  assert (out <= 1).all()
 

tests/test_generic.py

@@ -101,7 +101,7 @@ def test_doyminmax(self, q_series):
  for da in [dmx, dmn]:
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in da.attrs.keys()
- assert da.attrs["units"] == ""
+ assert da.attrs["units"] == "1"
  assert da.attrs["is_dayofyear"] == 1
 
 

tests/test_hydrology.py

@@ -40,7 +40,7 @@ def test_simple(self, snw_series):
  snw = snw_series(a, start="1999-01-01")
  out = xci.snw_max_doy(snw, freq="YS")
  np.testing.assert_array_equal(out, [11, np.nan])
- assert out.units == ""
+ assert out.units == "1"
 
 
 class TestSnowMeltWEMax:

tests/test_indices.py

@@ -137,11 +137,11 @@ def test_simple(self, tas_series):
 
  out = xci.cold_spell_frequency(da, thresh="-10. C", freq="ME")
  np.testing.assert_array_equal(out, [1, 0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0])
- assert out.units == ""
+ assert out.units == "1"
 
  out = xci.cold_spell_frequency(da, thresh="-10. C", freq="YS")
  np.testing.assert_array_equal(out, 3)
- assert out.units == ""
+ assert out.units == "1"
 
 
 class TestColdSpellMaxLength:
@@ -885,7 +885,7 @@ def test_simple(self, tas_series):
  assert lsf == 180
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in lsf.attrs.keys()
- assert lsf.attrs["units"] == ""
+ assert lsf.attrs["units"] == "1"
  assert lsf.attrs["is_dayofyear"] == 1
  assert lsf.attrs["is_dayofyear"].dtype == np.int32
 
@@ -906,7 +906,7 @@ def test_simple(self, tas_series):
  assert np.isnan(fdb)
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in fdb.attrs.keys()
- assert fdb.attrs["units"] == ""
+ assert fdb.attrs["units"] == "1"
  assert fdb.attrs["is_dayofyear"] == 1
 
  def test_below_forbidden(self, tasmax_series):
@@ -937,7 +937,7 @@ def test_simple(self, tas_series):
  assert np.isnan(fda)
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in fda.attrs.keys()
- assert fda.attrs["units"] == ""
+ assert fda.attrs["units"] == "1"
  assert fda.attrs["is_dayofyear"] == 1
 
  def test_thresholds(self, tas_series):
@@ -962,7 +962,7 @@ def test_thresholds(self, tas_series):
  assert out[0] == tg.indexes["time"][30].dayofyear
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in out.attrs.keys()
- assert out.attrs["units"] == ""
+ assert out.attrs["units"] == "1"
  assert out.attrs["is_dayofyear"] == 1
 
  def test_above_forbidden(self, tasmax_series):
@@ -1049,7 +1049,7 @@ def test_simple(self, tas_series):
  assert out[0] == tg.indexes["time"][20].dayofyear
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in out.attrs.keys()
- assert out.attrs["units"] == ""
+ assert out.attrs["units"] == "1"
  assert out.attrs["is_dayofyear"] == 1
 
  def test_no_start(self, tas_series):
@@ -1082,7 +1082,7 @@ def test_varying_mid_dates(self, tas_series, d1, d2, mid_date, expected):
  np.testing.assert_array_equal(gs_end, expected)
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in gs_end.attrs.keys()
- assert gs_end.attrs["units"] == ""
+ assert gs_end.attrs["units"] == "1"
  assert gs_end.attrs["is_dayofyear"] == 1
 
 
@@ -1162,7 +1162,7 @@ def test_simple(self, tasmin_series):
  assert out[0] == tn.indexes["time"][20].dayofyear
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in out.attrs.keys()
- assert out.attrs["units"] == ""
+ assert out.attrs["units"] == "1"
  assert out.attrs["is_dayofyear"] == 1
 
  def test_no_start(self, tasmin_series):
@@ -1195,7 +1195,7 @@ def test_varying_mid_dates(self, tasmin_series, d1, d2, mid_date, expected):
  np.testing.assert_array_equal(gs_end, expected)
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in gs_end.attrs.keys()
- assert gs_end.attrs["units"] == ""
+ assert gs_end.attrs["units"] == "1"
  assert gs_end.attrs["is_dayofyear"] == 1
 
 
@@ -2704,7 +2704,7 @@ def test_degree_days_exceedance_date(tas_series):
 
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in out.attrs.keys()
- assert out.attrs["units"] == ""
+ assert out.attrs["units"] == "1"
  assert out.attrs["is_dayofyear"] == 1
 
 
@@ -2744,7 +2744,7 @@ def test_first_snowfall(prsn_series, prsnd_series):
  assert out[0] == 166
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in out.attrs.keys()
- assert out.attrs["units"] == ""
+ assert out.attrs["units"] == "1"
  assert out.attrs["is_dayofyear"] == 1
 
  # test with prsnd [m s-1]
@@ -2753,7 +2753,7 @@ def test_first_snowfall(prsn_series, prsnd_series):
  assert out[0] == 166
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in out.attrs.keys()
- assert out.attrs["units"] == ""
+ assert out.attrs["units"] == "1"
  assert out.attrs["is_dayofyear"] == 1
 
  # test with prsn [kg m-2 s-1]
@@ -2765,7 +2765,7 @@ def test_first_snowfall(prsn_series, prsnd_series):
  assert out[0] == 166
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in out.attrs.keys()
- assert out.attrs["units"] == ""
+ assert out.attrs["units"] == "1"
  assert out.attrs["is_dayofyear"] == 1
 
 
@@ -2902,15 +2902,15 @@ def test_continous_snow_season_start(self, snd_series, snw_series):
  np.testing.assert_array_equal(out, [snd.time.dt.dayofyear[0].data + 2, np.nan])
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in out.attrs.keys()
- assert out.attrs["units"] == ""
+ assert out.attrs["units"] == "1"
  assert out.attrs["is_dayofyear"] == 1
 
  out = xci.snw_season_start(snw)
  assert len(out) == 2
  np.testing.assert_array_equal(out, [snw.time.dt.dayofyear[0].data + 1, np.nan])
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in out.attrs.keys()
- assert out.attrs["units"] == ""
+ assert out.attrs["units"] == "1"
  assert out.attrs["is_dayofyear"] == 1
 
  def test_snow_season_end(self, snd_series, snw_series):
@@ -2932,7 +2932,7 @@ def test_snow_season_end(self, snd_series, snw_series):
  np.testing.assert_array_equal(out, [(doy + 219) % 366, np.nan])
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in out.attrs.keys()
- assert out.attrs["units"] == ""
+ assert out.attrs["units"] == "1"
  assert out.attrs["is_dayofyear"] == 1
 
  out = xci.snw_season_end(snw)
@@ -2941,7 +2941,7 @@ def test_snow_season_end(self, snd_series, snw_series):
  np.testing.assert_array_equal(out, [(doy + 219) % 366, np.nan])
  for attr in ["units", "is_dayofyear", "calendar"]:
  assert attr in out.attrs.keys()
- assert out.attrs["units"] == ""
+ assert out.attrs["units"] == "1"
  assert out.attrs["is_dayofyear"] == 1
 
 

tests/test_land.py

@@ -10,19 +10,19 @@
 
 def test_base_flow_index(ndq_series):
  out = land.base_flow_index(ndq_series, freq="YS")
- assert out.attrs["units"] == ""
+ assert out.attrs["units"] == "1"
  assert isinstance(out, xr.DataArray)
 
 
 def test_rb_flashiness_index(ndq_series):
  out = land.base_flow_index(ndq_series, freq="YS")
- assert out.attrs["units"] == ""
+ assert out.attrs["units"] == "1"
  assert isinstance(out, xr.DataArray)
 
 
 def test_qdoy_max(ndq_series, q_series):
  out = land.doy_qmax(ndq_series, freq="YS", season="JJA")
- assert out.attrs["units"] == ""
+ assert out.attrs["units"] == "1"
 
  a = np.ones(450)
  a[100] = 2

tests/test_snow.py

@@ -45,11 +45,11 @@ def test_simple(self, snd_series):
  snd = snd.expand_dims(lat=[0, 1, 2])
 
  out = land.snd_season_start(snd)
- assert out.units == ""
+ assert out.units == "1"
  np.testing.assert_array_equal(out.isel(lat=0), snd.time.dt.dayofyear[100])
 
  out = land.snd_season_end(snd)
- assert out.units == ""
+ assert out.units == "1"
  np.testing.assert_array_equal(out.isel(lat=0), snd.time.dt.dayofyear[200])
 
  out = land.snd_season_length(snd)
@@ -67,11 +67,11 @@ def test_simple(self, snw_series):
  snw = snw.expand_dims(lat=[0, 1, 2])
 
  out = land.snw_season_start(snw)
- assert out.units == ""
+ assert out.units == "1"
  np.testing.assert_array_equal(out.isel(lat=0), snw.time.dt.dayofyear[100])
 
  out = land.snw_season_end(snw)
- assert out.units == ""
+ assert out.units == "1"
  np.testing.assert_array_equal(out.isel(lat=0), snw.time.dt.dayofyear[200])
 
  out = land.snw_season_length(snw)

tests/test_units.py

@@ -140,7 +140,7 @@ def test_units2pint(self, pr_series):
  assert pint2cfunits(u) == "%"
 
  u = units2pint("1")
- assert pint2cfunits(u) == ""
+ assert pint2cfunits(u) == "1"
 
  def test_pint_multiply(self, pr_series):
  a = pr_series([1, 2, 3])
@@ -331,8 +331,8 @@ def index(
  ("", "sum", "count", 365, "d"),
  ("", "sum", "count", 365, "d"),
  ("kg m-2", "var", "var", 0, "kg2 m-4"),
- ("°C", "argmax", "doymax", 0, ""),
- ("°C", "sum", "integral", 365, "K d"),
+ ("°C", "argmax", "doymax", 0, "1"),
+ ("°C", "sum", "integral", 365, "d K"),
  ("°F", "sum", "integral", 365, "d °R"), # not sure why the order is different
  ],
 )