dkist-processing-math 2.2.1__tar.gz → 2.2.3__tar.gz

{dkist_processing_math-2.2.1 → dkist_processing_math-2.2.3}/.readthedocs.yml

@@ -1,8 +1,8 @@
 version: 2
 build:
-  os: ubuntu-20.04
+  os: ubuntu-24.04
   tools:
-    python: "3.11"
+    python: "3.13"
   apt_packages:
     - libopenjp2-7
     - graphviz

{dkist_processing_math-2.2.1 → dkist_processing_math-2.2.3}/CHANGELOG.rst

@@ -1,3 +1,22 @@
+v2.2.3 (2026-06-15)
+===================
+
+Features
+--------
+
+- Add new method to find the closest datetime in a list to a target datetime. (`#26 <https://bitbucket.org/dkistdc/dkist-processing-math/pull-requests/26>`__)
+
+
+v2.2.2 (2026-04-16)
+===================
+
+Misc
+----
+
+- Update minimum required version of `python` and `dkist-processing-common` to address critical security vulnerabilities. (`#24 <https://bitbucket.org/dkistdc/dkist-processing-math/pull-requests/24>`__)
+- Upgrade Read the Docs LTS build image to Ubuntu 24.04. (`#25 <https://bitbucket.org/dkistdc/dkist-processing-math/pull-requests/25>`__)
+
+
 v2.2.1 (2025-08-30)
 ===================
 

{dkist_processing_math-2.2.1 → dkist_processing_math-2.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dkist-processing-math
-Version: 2.2.1
+Version: 2.2.3
 Summary: Common math functionality used in the DKIST calibrations suite
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause
@@ -10,10 +10,10 @@ Project-URL: Documentation, https://docs.dkist.nso.edu/projects/math
 Project-URL: Help, https://nso.atlassian.net/servicedesk/customer/portal/5
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.11
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.13
 Description-Content-Type: text/x-rst
-Requires-Dist: dkist-processing-common>=4.0.0
+Requires-Dist: dkist-processing-common>=13.0.0
 Requires-Dist: numpy>=1.24.0
 Requires-Dist: scikit-image>=0.21.0
 Requires-Dist: scipy>=1.11.0

{dkist_processing_math-2.2.1 → dkist_processing_math-2.2.3}/bitbucket-pipelines.yml

@@ -1,4 +1,4 @@
-image: python:3.11
+image: python:3.13
 definitions:
   steps:
     - step: &download_execute_script

{dkist_processing_math-2.2.1 → dkist_processing_math-2.2.3}/dkist_processing_math/arithmetic.py

@@ -1,5 +1,6 @@
 """Arithmetic."""
 
+from datetime import datetime
 from typing import Generator
 from typing import Iterable
 from typing import Union
@@ -124,3 +125,21 @@ def divide_fits_access_by_array(
     for obj in access_objs:
         obj.data = next(divide_arrays_by_array(obj.data, array_to_divide_by))
         yield obj
+
+
+def closest_datetime(
+    target_datetime: str | datetime, datetimes: list[str | datetime] | str | datetime
+) -> str | datetime:
+    """Find the closest datetime to a target datetime. Return type is of the same type as the datetimes list."""
+    if isinstance(target_datetime, str):
+        target_datetime = datetime.fromisoformat(target_datetime)
+    if isinstance(datetimes, str) or isinstance(datetimes, datetime):
+        datetimes = [datetimes]
+    converted_datetimes = [
+        datetime.fromisoformat(d) if isinstance(d, str) else d for d in datetimes
+    ]
+    closest_index, _ = min(
+        enumerate(converted_datetimes),
+        key=lambda dt: abs(dt[1] - target_datetime),
+    )
+    return datetimes[closest_index]

{dkist_processing_math-2.2.1 → dkist_processing_math-2.2.3}/dkist_processing_math/tests/test_arithmetic.py

@@ -1,3 +1,4 @@
+from datetime import datetime
 from typing import Generator
 
 import numpy as np
@@ -5,6 +6,7 @@ import pytest
 from astropy.io import fits
 from dkist_processing_common.models.fits_access import FitsAccessBase
 
+from dkist_processing_math.arithmetic import closest_datetime
 from dkist_processing_math.arithmetic import divide_arrays_by_array
 from dkist_processing_math.arithmetic import divide_fits_access_by_array
 from dkist_processing_math.arithmetic import subtract_array_from_arrays
@@ -18,7 +20,7 @@ def multiple_test_fits_access(request, numpy_arrays):
     for i, array in enumerate(numpy_arrays):
         hdu = fits.PrimaryHDU(data=array)
         hdu.header["TEST"] = i
-        access_list.append(FitsAccessBase(hdu=hdu))
+        access_list.append(FitsAccessBase(header=hdu.header, data=array))
     if request.param == "multiple":
         return access_list
     return access_list[0]
@@ -126,3 +128,54 @@ def test_divide_arrays_by_array_wrong_shape(numpy_arrays_wrong_shape, numpy_arra
     """
     with pytest.raises(ValueError):
         list(divide_arrays_by_array(numpy_arrays_wrong_shape, numpy_array))
+
+
+@pytest.mark.parametrize(
+    "datetimes, expected_result",
+    [
+        pytest.param(
+            ["2025-12-31T00:00:00", "2026-01-07T00:00:00"],
+            "2025-12-31T00:00:00",
+            id="multiple solar gain ops",
+        ),
+        pytest.param("2025-12-31T00:00:00", "2025-12-31T00:00:00", id="single solar gain op"),
+    ],
+)
+def test_closest_datetime_with_strings(datetimes, expected_result):
+    """
+    Given: a target datetime and a list of string datetimes
+    When: running the closest_datetime method
+    Then: the closest datetime from the list of datetimes is returned
+    """
+    result = closest_datetime(
+        target_datetime="2026-01-01T00:00:00",
+        datetimes=datetimes,
+    )
+    assert result == expected_result
+
+
+@pytest.mark.parametrize(
+    "datetimes, expected_result",
+    [
+        pytest.param(
+            [
+                datetime(2025, 12, 31),
+                datetime(2026, 1, 7),
+            ],
+            datetime(2025, 12, 31),
+            id="multiple solar gain ops",
+        ),
+        pytest.param(datetime(2025, 12, 31), datetime(2025, 12, 31), id="single solar gain op"),
+    ],
+)
+def test_closest_datetime_with_datetimes(datetimes, expected_result):
+    """
+    Given: a target datetime and a list of datetimes
+    When: running the closest_datetime method
+    Then: the closest datetime from the list of datetimes is returned
+    """
+    result = closest_datetime(
+        target_datetime=datetime(2026, 1, 1),
+        datetimes=datetimes,
+    )
+    assert result == expected_result

{dkist_processing_math-2.2.1 → dkist_processing_math-2.2.3}/dkist_processing_math.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dkist-processing-math
-Version: 2.2.1
+Version: 2.2.3
 Summary: Common math functionality used in the DKIST calibrations suite
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause
@@ -10,10 +10,10 @@ Project-URL: Documentation, https://docs.dkist.nso.edu/projects/math
 Project-URL: Help, https://nso.atlassian.net/servicedesk/customer/portal/5
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.11
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.13
 Description-Content-Type: text/x-rst
-Requires-Dist: dkist-processing-common>=4.0.0
+Requires-Dist: dkist-processing-common>=13.0.0
 Requires-Dist: numpy>=1.24.0
 Requires-Dist: scikit-image>=0.21.0
 Requires-Dist: scipy>=1.11.0

{dkist_processing_math-2.2.1 → dkist_processing_math-2.2.3}/dkist_processing_math.egg-info/requires.txt

@@ -1,4 +1,4 @@
-dkist-processing-common>=4.0.0
+dkist-processing-common>=13.0.0
 numpy>=1.24.0
 scikit-image>=0.21.0
 scipy>=1.11.0

{dkist_processing_math-2.2.1 → dkist_processing_math-2.2.3}/pyproject.toml

@@ -10,7 +10,7 @@ find = {}
 [project]
 dynamic = ["version"]
 name = "dkist-processing-math"
-requires-python = ">=3.11"
+requires-python = ">=3.13"
 description = "Common math functionality used in the DKIST calibrations suite"
 readme = "README.rst"
 authors = [ {name = "NSO / AURA", email = "dkistdc@nso.edu"} ]
@@ -18,10 +18,10 @@ license = {text = "BSD-3-Clause"}
 classifiers = [
   "Programming Language :: Python",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.13",
 ]
 dependencies = [
-  "dkist-processing-common >= 4.0.0",
+  "dkist-processing-common >= 13.0.0",
   "numpy >= 1.24.0",
   "scikit-image >= 0.21.0",
   "scipy >= 1.11.0",