Change aggregate_by to sum_by

Author: leosaffin

huracanpy/_accessor.py

@@ -545,9 +545,7 @@ def get_track_duration(self, time_name="time", track_id_name="track_id"):
 
     def get_track_ace(self, wind_name="wind", track_id_name="track_id", **kwargs):
         return tc.ace(
-            self._dataset[wind_name],
-            aggregate_by=self._dataset[track_id_name],
-            **kwargs,
+            self._dataset[wind_name], sum_by=self._dataset[track_id_name], **kwargs
         )
 
     def get_track_pace(
@@ -560,7 +558,7 @@ def get_track_pace(
         return tc.pace(
             self._dataset[pressure_name],
             wind,
-            aggregate_by=self._dataset[track_id_name],
+            sum_by=self._dataset[track_id_name],
             **kwargs,
         )
 

huracanpy/tc/_ace.py

@@ -11,7 +11,7 @@
 
 def ace(
     wind,
-    aggregate_by=None,
+    sum_by=None,
     threshold=34 * units("knots"),
     wind_units="m s-1",
 ):
@@ -20,11 +20,11 @@ def ace(
     .. math:: \mathrm{ACE} = 10^{-4} \sum v_\mathrm{max}^2 \quad (v_\mathrm{max} \ge 34 \mathrm{kn})
 
     By default, this function will return the "ACE" for each individual point in `wind`.
-    To calculate more useful quantities of ACE, use the `aggregate_by` keyword.
+    To calculate more useful quantities of ACE, use the `sum_by` keyword.
 
     For example, to calculate the ACE of each individual track, doing
 
-    >>> ace_by_track = huracanpy.tc.ace(tracks.wind, aggregate_by=tracks.track_id)
+    >>> ace_by_track = huracanpy.tc.ace(tracks.wind, sum_by=tracks.track_id)
 
     will return a DataArray with track_id as a coordinate and the sum of ACE for each
     track as the data. Note that this is equivalent to using groupby:
@@ -38,13 +38,13 @@ def ace(
 
     Similarly to calculate a climatological mean ACE by year, run
 
-    >>> climatological_ace = huracanpy.tc.ace(tracks.wind, aggregate_by=tracks.time.dt.year).mean()
+    >>> climatological_ace = huracanpy.tc.ace(tracks.wind,sum_by=tracks.time.dt.year).mean()
 
     Parameters
     ----------
     wind : array_like
         Maximum velocity of a tropical cyclone associated with the tracks dataset
-    aggregate_by : array_like
+    sum_by : array_like
         Variable to take the sum of ACE values across. Must have the same length as wind
     threshold : scalar, default=34 knots
         ACE is set to zero below this threshold wind speed. The default argument is in
@@ -64,8 +64,8 @@ def ace(
 
     ace_values = get_ace(wind, threshold, wind_units)
 
-    if aggregate_by is not None:
-        ace_values = ace_values.groupby(aggregate_by).sum()
+    if sum_by is not None:
+        ace_values = ace_values.groupby(sum_by).sum()
 
     return ace_values
 
@@ -74,7 +74,7 @@ def pace(
     pressure,
     wind=None,
     model=None,
-    aggregate_by=None,
+    sum_by=None,
     threshold_wind=None,
     threshold_pressure=None,
     wind_units="m s-1",
@@ -108,7 +108,7 @@ def pace(
     pressure : array_like
     wind : array_like, optional
     model : str, class, or object, optional
-    aggregate_by : array_like
+    sum_by : array_like
         Variable to take the sum of PACE values across. Must have the same length as
         pressure/wind. For examples, see the documentation for `huracanpy.tc.ace`
     threshold_wind : scalar, optional
@@ -133,8 +133,8 @@ def pace(
         **kwargs,
     )
 
-    if aggregate_by is not None:
-        pace_values = pace_values.groupby(aggregate_by).sum()
+    if sum_by is not None:
+        pace_values = pace_values.groupby(sum_by).sum()
 
     return pace_values, model
 

tests/test_accessor.py

@@ -166,7 +166,7 @@ def test_get_methods():
     ace_acc = data.hrcn.get_track_ace(
         wind_name="wind10",
     )
-    ace_fct = huracanpy.tc.ace(data.wind10, aggregate_by=data.track_id)
+    ace_fct = huracanpy.tc.ace(data.wind10, sum_by=data.track_id)
     np.testing.assert_array_equal(
         ace_acc,
         ace_fct,
@@ -177,7 +177,7 @@ def test_get_methods():
     pace_acc, _ = data.hrcn.get_track_pace(
         wind_name="wind10",
     )
-    pace_fct, _ = huracanpy.tc.pace(data.slp, data.wind10, aggregate_by=data.track_id)
+    pace_fct, _ = huracanpy.tc.pace(data.slp, data.wind10, sum_by=data.track_id)
     np.testing.assert_array_equal(
         pace_acc,
         pace_fct,

tests/test_tc/test_ace.py

@@ -5,16 +5,16 @@
 
 
 @pytest.mark.parametrize(
-    "aggregate_by, result",
+    "sum_by, result",
     [(None, [10.0894797]), ("track_id", [3.03623809, 2.21637375, 4.83686787])],
 )
-def test_ace(aggregate_by, result):
+def test_ace(sum_by, result):
     data = huracanpy.load(huracanpy.example_csv_file, source="csv")
 
-    if aggregate_by is not None:
-        aggregate_by = data[aggregate_by]
-    ace = huracanpy.tc.ace(data.wind10, aggregate_by=aggregate_by)
-    if aggregate_by is None:
+    if sum_by is not None:
+        sum_by = data[sum_by]
+    ace = huracanpy.tc.ace(data.wind10, sum_by=sum_by)
+    if sum_by is None:
         ace = ace.sum()
 
     np.testing.assert_allclose(ace, result)
@@ -25,19 +25,11 @@ def test_ace(aggregate_by, result):
 def test_pace():
     data = huracanpy.load(huracanpy.example_csv_file, source="csv")
     # Pass wind values to fit a (quadratic) model to the pressure-wind relationship
-    pace, model = huracanpy.tc.pace(
-        data.slp,
-        data.wind10,
-        aggregate_by=data.track_id,
-    )
+    pace, model = huracanpy.tc.pace(data.slp, data.wind10, sum_by=data.track_id)
 
     np.testing.assert_allclose(pace, np.array([4.34978137, 2.65410482, 6.09892875]))
 
     # Call with the already fit model instead of wind values
-    pace, _ = huracanpy.tc.pace(
-        data.slp,
-        model=model,
-        aggregate_by=data.track_id,
-    )
+    pace, _ = huracanpy.tc.pace(data.slp, model=model, sum_by=data.track_id)
 
     np.testing.assert_allclose(pace, np.array([4.34978137, 2.65410482, 6.09892875]))