climate-resource · florence-bockting · Apr 2, 2025 · Apr 2, 2025 · Apr 2, 2025 · Apr 2, 2025
diff --git a/changelog/16.feature.md b/changelog/16.feature.md
@@ -0,0 +1,12 @@
++ include support for polynomial-decay (besides cosine-decay)
++ we added three new classes/functions to the API in the module `convergence`
+  + `PolynomialDecaySplineHelper`
+  + `PolynomialDecaySplineHelperDerivative`
+  + `get_polynomial_decay_harmonised_spline`
++ whereby the function `get_polynomial_decay_harmonised_spline` is mainly meant as user-interface
+  This function can be used as value for the `get_harmonise_spline` parameter in `harmonise`.
+  The function takes the same arguments as `get_cosine_decay_harmonised_spline` and additionally a
+  `power` argument.
++ The `power` argument can be passed to the function using
+  `functools.partial(get_polynomial_decay_harmonised_spline, power=2)`
++ An example use-case is added to the `getting-started-tutorial`.
-+ include support for polynomial-decay (besides cosine-decay)
-+ we added three new classes/functions to the API in the module `convergence`
-  + `PolynomialDecaySplineHelper`
-  + `PolynomialDecaySplineHelperDerivative`
-  + `get_polynomial_decay_harmonised_spline`
-+ whereby the function `get_polynomial_decay_harmonised_spline` is mainly meant as user-interface
-  This function can be used as value for the `get_harmonise_spline` parameter in `harmonise`.
-  The function takes the same arguments as `get_cosine_decay_harmonised_spline` and additionally a
-  `power` argument.
-+ The `power` argument can be passed to the function using
-  `functools.partial(get_polynomial_decay_harmonised_spline, power=2)`
-+ An example use-case is added to the `getting-started-tutorial`.
+ Included support for polynomial-decay (adds to the existing cosine-decay)
+ Added new features to [convergence][gradient_aware_harmonisation.convergence]
+  + [PolynomialDecaySplineHelper][gradient_aware_harmonisation.convergence.PolynomialDecaySplineHelper]
+  + [PolynomialDecaySplineHelperDerivative][gradient_aware_harmonisation.convergence.PolynomialDecaySplineHelperDerivative]
+  + [get_polynomial_decay_harmonised_spline][gradient_aware_harmonisation.convergence.get_polynomial_decay_harmonised_spline]
+ The function [get_polynomial_decay_harmonised_spline][gradient_aware_harmonisation.convergence.get_polynomial_decay_harmonised_spline] is an adapter between the underlying classes and the interface required for the `get_harmonise_spline` parameter in [harmonise][gradient_aware_harmonisation.harmonise].
+  The function takes the same arguments as [get_cosine_decay_harmonised_spline][gradient_aware_harmonisation.convergence.get_cosine_decay_harmonised_spline] and an additional
+  `power` argument. The `power` argument can be 'pre-passed' to the function using [functools.partial](https://docs.python.org/3/library/functools.html#functools.partial) e.g. `harmonise(..., get_harmonise_spline=functools.partial(get_polynomial_decay_harmonised_spline, power=2)...)`
+ An example use-case is included in the [getting started tutorial][gradient-aware-harmonisation-getting-started].
-+ include support for polynomial-decay (besides cosine-decay)
-+ we added three new classes/functions to the API in the module `convergence`
-  + `PolynomialDecaySplineHelper`
-  + `PolynomialDecaySplineHelperDerivative`
-  + `get_polynomial_decay_harmonised_spline`
-+ whereby the function `get_polynomial_decay_harmonised_spline` is mainly meant as user-interface
-  This function can be used as value for the `get_harmonise_spline` parameter in `harmonise`.
-  The function takes the same arguments as `get_cosine_decay_harmonised_spline` and additionally a
-  `power` argument.
-+ The `power` argument can be passed to the function using
-  `functools.partial(get_polynomial_decay_harmonised_spline, power=2)`
-+ An example use-case is added to the `getting-started-tutorial`.
+ Included support for polynomial-decay (adds to the existing cosine-decay)
+ Added new features to [convergence][gradient_aware_harmonisation.convergence]
+  + [PolynomialDecaySplineHelper][gradient_aware_harmonisation.convergence.PolynomialDecaySplineHelper]
+  + [PolynomialDecaySplineHelperDerivative][gradient_aware_harmonisation.convergence.PolynomialDecaySplineHelperDerivative]
+  + [get_polynomial_decay_harmonised_spline][gradient_aware_harmonisation.convergence.get_polynomial_decay_harmonised_spline]
+ The function [get_polynomial_decay_harmonised_spline][gradient_aware_harmonisation.convergence.get_polynomial_decay_harmonised_spline] is an adapter between the underlying classes and the interface required for the `get_harmonise_spline` parameter in [harmonise][gradient_aware_harmonisation.harmonise].
+  The function takes the same arguments as [get_cosine_decay_harmonised_spline][gradient_aware_harmonisation.convergence.get_cosine_decay_harmonised_spline] and an additional
+  `power` argument. The `power` argument can be 'pre-passed' to the function using [functools.partial](https://docs.python.org/3/library/functools.html#functools.partial) e.g. `harmonise(..., get_harmonise_spline=functools.partial(get_polynomial_decay_harmonised_spline, power=2)...)`
+ An example use-case is included in the [getting started tutorial][gradient-aware-harmonisation-getting-started].
diff --git a/changelog/17.fix.md b/changelog/17.fix.md
@@ -0,0 +1 @@
++ fix computation of cosine decay derivative (we forgot a constant value in the formula)
-+ fix computation of cosine decay derivative (we forgot a constant value in the formula)
+ Fixed computation of cosine decay derivative (a constant factor was missing)
-+ fix computation of cosine decay derivative (we forgot a constant value in the formula)
+ Fixed computation of cosine decay derivative (a constant factor was missing)
diff --git a/docs/tutorials/tutorial.py b/docs/tutorials/tutorial.py
@@ -26,9 +26,14 @@
 
 # %%
 # Imports
+from functools import partial
+
 import numpy as np
 
 from gradient_aware_harmonisation import harmonise
+from gradient_aware_harmonisation.convergence import (
+    get_polynomial_decay_harmonised_spline,
+)
 from gradient_aware_harmonisation.plotting import plotting
 from gradient_aware_harmonisation.timeseries import Timeseries
 
@@ -96,6 +101,27 @@
     convergence_time,
 )
 
+# %% [markdown]
+# ### Use polynomial-decay
+
+# %%
+convergence_time = 8.0
+
+harmonised_timeseries = harmonise(
+    target_timeseries=target_timeseries,
+    harmonisee_timeseries=harmonisee_timeseries,
+    harmonisation_time=harmonisation_time,
+    convergence_time=convergence_time,
+    get_harmonised_spline=partial(get_polynomial_decay_harmonised_spline, power=2.0),
+)
+
+plotting(
+    harmonisee_timeseries,
+    target_timeseries,
+    harmonised_timeseries,
+    harmonisation_time,
+    convergence_time,
+)
 # %% [markdown]
 # ## Toy Example 2: Use timeseries data
 # ### Read data