dkist-processing-common 11.2.0__tar.gz → 11.2.1__tar.gz

{dkist_processing_common-11.2.0 → dkist_processing_common-11.2.1}/CHANGELOG.rst

@@ -1,3 +1,20 @@
+v11.2.1 (2025-08-12)
+====================
+
+Bugfixes
+--------
+
+- Add `multi_plot_data` to quality creation mutation when submitting quality report data. (`#262 <https://bitbucket.org/dkistdc/dkist-processing-common/pull-requests/262>`__)
+
+
+Misc
+----
+
+- Explicitly set color and ordering of lines in wavecal metric plots.
+  This gets around issues with order not being preserved in the quality database. (`#262 <https://bitbucket.org/dkistdc/dkist-processing-common/pull-requests/262>`__)
+- Update database name for vertical multi-pane plot metric data. It's now called "multi_plot_data". (`#262 <https://bitbucket.org/dkistdc/dkist-processing-common/pull-requests/262>`__)
+
+
 v11.2.0 (2025-07-18)
 ====================
 

{dkist_processing_common-11.2.0 → dkist_processing_common-11.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dkist-processing-common
-Version: 11.2.0
+Version: 11.2.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.0; extra == "quality"
+Requires-Dist: dkist-quality<3.0,>=2.0.0; extra == "quality"
 
 dkist-processing-common
 =======================

{dkist_processing_common-11.2.0 → dkist_processing_common-11.2.1}/dkist_processing_common/models/graphql.py

@@ -190,6 +190,7 @@ class QualityCreation(GraphqlBaseModel):
     warnings: str | None = None
     # JSON objects
     plotData: str | None = None
+    multiPlotData: str | None = None
     tableData: str | None = None
     histogramData: str | None = None
     modmatData: str | None = None

{dkist_processing_common-11.2.0 → dkist_processing_common-11.2.1}/dkist_processing_common/models/quality.py

@@ -112,7 +112,7 @@ class ReportMetric(BaseModel):
     facet: str | None = None
     statement: str | list[str] | None = None
     plot_data: Plot2D | list[Plot2D] | None = None
-    vertical_multi_pane_plot_data: VerticalMultiPanePlot2D | None = None
+    multi_plot_data: VerticalMultiPanePlot2D | None = None
     histogram_data: PlotHistogram | list[PlotHistogram] | None = None
     table_data: SimpleTable | list[SimpleTable] | None = None
     modmat_data: ModulationMatrixHistograms | None = None

{dkist_processing_common-11.2.0 → dkist_processing_common-11.2.1}/dkist_processing_common/tasks/mixin/metadata_store.py

@@ -171,6 +171,7 @@ class MetadataStoreMixin:
                 warnings=json.dumps(metric.get("warnings")),
                 # JSON objects
                 plotData=json.dumps(metric.get("plot_data"), cls=QualityDataEncoder),
+                multiPlotData=json.dumps(metric.get("multi_plot_data"), cls=QualityDataEncoder),
                 tableData=json.dumps(metric.get("table_data"), cls=QualityDataEncoder),
                 histogramData=json.dumps(metric.get("histogram_data"), cls=QualityDataEncoder),
                 modmatData=json.dumps(metric.get("modmat_data"), cls=QualityDataEncoder),

{dkist_processing_common-11.2.0 → dkist_processing_common-11.2.1}/dkist_processing_common/tasks/mixin/quality/_metrics.py

@@ -1401,10 +1401,20 @@ class _WavecalQualityMixin:
             "Input Spectrum": [input_wave_list, input_spectrum_list],
             "Best Fit Atlas": [best_fit_wave_list, best_fit_atlas_list],
         }
+
+        # Set the colors and zorder here manually because the JSON-ization of the quality data means we can't be sure of
+        # the order these will be plotted in and thus can't rely on the default color-cycler in `dkist-quality`.
         fit_plot_kwargs = {
-            "Best Fit Observations": {"ls": "-", "lw": 4, "alpha": 0.8, "ms": 0},
-            "Input Spectrum": {"ls": "-", "alpha": 0.4, "ms": 0},
-            "Best Fit Atlas": {"color": "k", "ls": "-", "ms": 0},
+            "Best Fit Observations": {
+                "ls": "-",
+                "lw": 4,
+                "alpha": 0.8,
+                "ms": 0,
+                "color": "#FAA61C",
+                "zorder": 2,
+            },
+            "Input Spectrum": {"ls": "-", "alpha": 0.4, "ms": 0, "color": "#1E317A", "zorder": 2.1},
+            "Best Fit Atlas": {"color": "k", "ls": "-", "ms": 0, "zorder": 2.2},
         }
 
         fit_plot = Plot2D(
@@ -1458,7 +1468,7 @@ class _WavecalQualityMixin:
             "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 fit residuals.",
             metric_code=MetricCode.wavecal_fit,
-            vertical_multi_pane_plot_data=full_plot,
+            multi_plot_data=full_plot,
         )
 
         return metric.model_dump()

{dkist_processing_common-11.2.0 → dkist_processing_common-11.2.1}/dkist_processing_common/tests/test_assemble_quality.py

@@ -259,11 +259,11 @@ def plot_data_expected() -> Callable[[str], bool]:
 
 
 @pytest.fixture()
-def vertical_multi_pane_plot_data_expected() -> Callable[[str], bool]:
+def multi_plot_data_expected() -> Callable[[str], bool]:
     """
     Tightly coupled with quality_metrics fixture and resultant report metric name
     """
-    # names where vertical_multi_pane_plot_data is expected to be populated
+    # names where multi_plot_data is expected to be populated
     names = {"Wavelength Calibration Results"}
 
     def expected(name: str) -> bool:
@@ -451,7 +451,7 @@ def test_assemble_quality_data(
     assemble_quality_data_task,
     recipe_run_id,
     plot_data_expected,
-    vertical_multi_pane_plot_data_expected,
+    multi_plot_data_expected,
     table_data_expected,
     modmat_data_expected,
     histogram_data_expected,
@@ -481,8 +481,8 @@ def test_assemble_quality_data(
         assert isinstance(rm.description, str)
         if plot_data_expected(rm.name):
             assert rm.plot_data
-        if vertical_multi_pane_plot_data_expected(rm.name):
-            assert rm.vertical_multi_pane_plot_data
+        if multi_plot_data_expected(rm.name):
+            assert rm.multi_plot_data
         if table_data_expected(rm.name):
             assert rm.table_data
         if modmat_data_expected(rm.name):

{dkist_processing_common-11.2.0 → dkist_processing_common-11.2.1}/dkist_processing_common/tests/test_quality_mixin.py

@@ -114,7 +114,7 @@ def test_create_2d_plot_with_datetime_metric(quality_task):
         "facet",
         "statement",
         "plot_data",
-        "vertical_multi_pane_plot_data",
+        "multi_plot_data",
         "histogram_data",
         "table_data",
         "modmat_data",
@@ -1317,7 +1317,7 @@ def test_build_wavecal_results(quality_task, wavecal_data_json):
     assert metric["raincloud_data"] is None
     assert metric["warnings"] is None
 
-    multi_plot_data = metric["vertical_multi_pane_plot_data"]
+    multi_plot_data = metric["multi_plot_data"]
     assert multi_plot_data["match_x_axes"] is True
     assert multi_plot_data["no_gap"] is True
     assert (
@@ -1339,9 +1339,16 @@ def test_build_wavecal_results(quality_task, wavecal_data_json):
         "Best Fit Atlas": [[1001.5, 1002.6, 1003.7, 1004.8], [1.0, 1.0, 0.4, 1.0]],
     }
     assert fit_plot["plot_kwargs"] == {
-        "Input Spectrum": {"ls": "-", "alpha": 0.4, "ms": 0},
-        "Best Fit Observations": {"ls": "-", "lw": 4, "alpha": 0.8, "ms": 0},
-        "Best Fit Atlas": {"color": "k", "ls": "-", "ms": 0},
+        "Input Spectrum": {"ls": "-", "alpha": 0.4, "ms": 0, "color": "#1E317A", "zorder": 2.1},
+        "Best Fit Observations": {
+            "ls": "-",
+            "lw": 4,
+            "alpha": 0.8,
+            "ms": 0,
+            "color": "#FAA61C",
+            "zorder": 2.0,
+        },
+        "Best Fit Atlas": {"color": "k", "ls": "-", "ms": 0, "zorder": 2.2},
     }
 
     residuals_plot = plot_list[1]

{dkist_processing_common-11.2.0 → dkist_processing_common-11.2.1}/dkist_processing_common.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dkist-processing-common
-Version: 11.2.0
+Version: 11.2.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.0; extra == "quality"
+Requires-Dist: dkist-quality<3.0,>=2.0.0; extra == "quality"
 
 dkist-processing-common
 =======================

{dkist_processing_common-11.2.0 → dkist_processing_common-11.2.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.0
+dkist-quality<3.0,>=2.0.0
 
 [test]
 pytest

{dkist_processing_common-11.2.0 → dkist_processing_common-11.2.1}/pyproject.toml

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