dkist-processing-common 11.0.0rc2__tar.gz → 11.0.1__tar.gz

{dkist_processing_common-11.0.0rc2 → dkist_processing_common-11.0.1}/CHANGELOG.rst

@@ -1,3 +1,31 @@
+v11.0.1 (2025-07-10)
+====================
+
+Bugfixes
+--------
+
+- Ignore NaN and Inf values when storing the quality results of a wavelength calibration fit. (`#260 <https://bitbucket.org/dkistdc/dkist-processing-common/pull-requests/260>`__)
+
+
+Misc
+----
+
+- Removing usages of `pkg_resources`, which is on track to be deprecated. (`#254 <https://bitbucket.org/dkistdc/dkist-processing-common/pull-requests/254>`__)
+
+
+v11.0.0 (2025-07-02)
+====================
+
+Features
+--------
+
+- Move `location_of_dkist` from the `WriteL1` task to its own module (`~dkist_processing_common.models.dkist_location`).
+  Also make it a constant variable instead of a function. (`#256 <https://bitbucket.org/dkistdc/dkist-processing-common/pull-requests/256>`__)
+- `Stems` that only match a specific task types can now check against a list of task types.
+  This replaces the `ip_task_type` kwarg with `ip_task_types` (which can still be a single string, if desired.) (`#257 <https://bitbucket.org/dkistdc/dkist-processing-common/pull-requests/257>`__)
+- Add ability to store and build a quality metric showing the results of wavelength calibration. (`#259 <https://bitbucket.org/dkistdc/dkist-processing-common/pull-requests/259>`__)
+
+
 v10.9.0 (2025-06-02)
 ====================
 

{dkist_processing_common-11.0.0rc2 → dkist_processing_common-11.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dkist-processing-common
-Version: 11.0.0rc2
+Version: 11.0.1
 Summary: Common task classes used by the DKIST science data processing pipelines
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause
@@ -61,7 +61,7 @@ Requires-Dist: dkist-inventory<2.0,>=1.6.0; extra == "inventory"
 Provides-Extra: asdf
 Requires-Dist: dkist-inventory[asdf]<2.0,>=1.6.0; extra == "asdf"
 Provides-Extra: quality
-Requires-Dist: dkist-quality<2.0,>=1.3.0rc2; extra == "quality"
+Requires-Dist: dkist-quality<2.0,>=1.3.0; extra == "quality"
 
 dkist-processing-common
 =======================

{dkist_processing_common-11.0.0rc2 → dkist_processing_common-11.0.1}/dkist_processing_common/tasks/assemble_movie.py

@@ -2,10 +2,10 @@
 import logging
 from abc import ABC
 from abc import abstractmethod
+from importlib.resources import files
 from typing import Literal
 
 import numpy as np
-import pkg_resources
 from matplotlib import colormaps
 from moviepy import VideoClip
 from PIL import Image
@@ -66,7 +66,7 @@ class AssembleMovie(WorkflowTaskBase, ABC):
     MINIMUM_DURATION = 10  # seconds
     MAXIMUM_DURATION = 60  # seconds
     FPS = 15
-    FONT_FILE = pkg_resources.resource_filename("dkist_processing_common", "fonts/Lato-Regular.ttf")
+    FONT_FILE = files("dkist_processing_common").joinpath("fonts/Lato-Regular.ttf")
     TEXT_MARGIN_PX = 5
     MPL_COLOR_MAP = "viridis"
 

{dkist_processing_common-11.0.0rc2 → dkist_processing_common-11.0.1}/dkist_processing_common/tasks/mixin/quality/_metrics.py

@@ -1365,13 +1365,22 @@ class _WavecalQualityMixin:
         wcs = WCS(best_fit_header)
         best_fit_wavelength = wcs.spectral.pixel_to_world(np.arange(input_spectrum.size))
 
+        finite_idx = (
+            np.isfinite(input_wavelength)
+            * np.isfinite(input_spectrum)
+            * np.isfinite(best_fit_wavelength)
+            * np.isfinite(best_fit_atlas)
+            * np.isfinite(normalized_residuals)
+            * np.isfinite(weight_data)
+        )
+
         data = {
-            "input_wavelength_nm": input_wavelength.to_value(u.nm).tolist(),
-            "input_spectrum": input_spectrum.tolist(),
-            "best_fit_wavelength_nm": best_fit_wavelength.to_value(u.nm).tolist(),
-            "best_fit_atlas": best_fit_atlas.tolist(),
-            "normalized_residuals": normalized_residuals.tolist(),
-            "weights": None if weights is None else weight_data.tolist(),
+            "input_wavelength_nm": input_wavelength.to_value(u.nm)[finite_idx].tolist(),
+            "input_spectrum": input_spectrum[finite_idx].tolist(),
+            "best_fit_wavelength_nm": best_fit_wavelength.to_value(u.nm)[finite_idx].tolist(),
+            "best_fit_atlas": best_fit_atlas[finite_idx].tolist(),
+            "normalized_residuals": normalized_residuals[finite_idx].tolist(),
+            "weights": None if weights is None else weight_data[finite_idx].tolist(),
         }
 
         self._record_values(values=data, tags=[Tag.quality(MetricCode.wavecal_fit)])
@@ -1447,7 +1456,7 @@ class _WavecalQualityMixin:
             name="Wavelength Calibration Results",
             description="These plots show the wavelength solution computed based on fits to a Solar FTS atlas. "
             "The top plot shows the input and best-fit spectra along with the best-fit atlas, which is "
-            "a combination of Solar and Telluric spectra. The bottom plot shows the fir residuals.",
+            "a combination of Solar and Telluric spectra. The bottom plot shows the fit residuals.",
             metric_code=MetricCode.wavecal_fit,
             vertical_multi_pane_plot_data=full_plot,
         )

{dkist_processing_common-11.0.0rc2 → dkist_processing_common-11.0.1}/dkist_processing_common/tests/test_quality_mixin.py

@@ -1201,12 +1201,16 @@ def wavecal_input_wavelength() -> u.Quantity:
 
 @pytest.fixture(scope="session")
 def wavecal_input_spectrum(wavecal_input_wavelength) -> np.ndarray:
-    return (wavecal_input_wavelength.value - wavecal_input_wavelength.size // 2) ** 2 + 10.0
+    spec = (wavecal_input_wavelength.value - wavecal_input_wavelength.size // 2) ** 2 + 10.0
+    spec[spec.size // 2] = np.nan
+    return spec
 
 
 @pytest.fixture(scope="session")
 def wavecal_weights(wavecal_input_wavelength) -> np.ndarray:
-    return np.arange(wavecal_input_wavelength.size)
+    weights = np.arange(wavecal_input_wavelength.size, dtype=float)
+    weights[0] = np.inf
+    return weights
 
 
 @pytest.fixture(scope="session")
@@ -1300,7 +1304,7 @@ def test_build_wavecal_results(quality_task, wavecal_data_json):
     assert metric["description"] == (
         "These plots show the wavelength solution computed based on fits to a Solar FTS atlas. "
         "The top plot shows the input and best-fit spectra along with the best-fit atlas, which is "
-        "a combination of Solar and Telluric spectra. The bottom plot shows the fir residuals."
+        "a combination of Solar and Telluric spectra. The bottom plot shows the fit residuals."
     )
     assert metric["metric_code"] == MetricCode.wavecal_fit.value
     assert metric["facet"] is None

{dkist_processing_common-11.0.0rc2 → dkist_processing_common-11.0.1}/dkist_processing_common/tests/test_workflow_task_base.py

@@ -2,12 +2,11 @@ import json
 import logging
 import re
 import tomllib
-from dataclasses import asdict
+from importlib.metadata import version
 from pathlib import Path
 from string import ascii_uppercase
 
 import pytest
-from pkg_resources import get_distribution
 from sqids import Sqids
 
 import dkist_processing_common
@@ -272,7 +271,7 @@ def test_library_versions(provenance_task, package_dependencies):
     #   installed packages.
     for package in package_dependencies:
         assert package in libraries
-        assert libraries[package] == get_distribution(package).version
+        assert libraries[package] == version(package)
 
 
 def test_record_provenance(provenance_task):

{dkist_processing_common-11.0.0rc2 → dkist_processing_common-11.0.1}/dkist_processing_common.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dkist-processing-common
-Version: 11.0.0rc2
+Version: 11.0.1
 Summary: Common task classes used by the DKIST science data processing pipelines
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause
@@ -61,7 +61,7 @@ Requires-Dist: dkist-inventory<2.0,>=1.6.0; extra == "inventory"
 Provides-Extra: asdf
 Requires-Dist: dkist-inventory[asdf]<2.0,>=1.6.0; extra == "asdf"
 Provides-Extra: quality
-Requires-Dist: dkist-quality<2.0,>=1.3.0rc2; extra == "quality"
+Requires-Dist: dkist-quality<2.0,>=1.3.0; extra == "quality"
 
 dkist-processing-common
 =======================

{dkist_processing_common-11.0.0rc2 → dkist_processing_common-11.0.1}/dkist_processing_common.egg-info/SOURCES.txt

@@ -7,9 +7,6 @@ README.rst
 bitbucket-pipelines.yml
 pyproject.toml
 changelog/.gitempty
-changelog/256.feature.rst
-changelog/257.feature.rst
-changelog/259.feature.rst
 dkist_processing_common/__init__.py
 dkist_processing_common/config.py
 dkist_processing_common/manual.py

{dkist_processing_common-11.0.0rc2 → dkist_processing_common-11.0.1}/dkist_processing_common.egg-info/requires.txt

@@ -39,7 +39,7 @@ dkist-sphinx-theme
 dkist-inventory<2.0,>=1.6.0
 
 [quality]
-dkist-quality<2.0,>=1.3.0rc2
+dkist-quality<2.0,>=1.3.0
 
 [test]
 pytest

{dkist_processing_common-11.0.0rc2 → dkist_processing_common-11.0.1}/pyproject.toml

@@ -82,7 +82,7 @@ asdf = [
   "dkist-inventory[asdf] >= 1.6.0, <2.0",
 ]
 quality = [
-  "dkist-quality >= 1.3.0rc2, <2.0",
+  "dkist-quality >= 1.3.0, <2.0",
 ]
 
 [tool.pytest.ini_options]

dkist_processing_common-11.0.0rc2/changelog/256.feature.rst

@@ -1,2 +0,0 @@
-Move `location_of_dkist` from the `WriteL1` task to its own module (`~dkist_processing_common.models.dkist_location`).
-Also make it a constant variable instead of a function.

dkist_processing_common-11.0.0rc2/changelog/257.feature.rst

@@ -1 +0,0 @@
-`Stems` that only match a specific task types can now check against a list of task types.

dkist_processing_common-11.0.0rc2/changelog/259.feature.rst

@@ -1 +0,0 @@
-Add ability to store and build a quality metric showing the results of wavelength calibration.