dkist-processing-common 14.6.1__tar.gz → 14.7.0rc1__tar.gz

{dkist_processing_common-14.6.1 → dkist_processing_common-14.7.0rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dkist-processing-common
-Version: 14.6.1
+Version: 14.7.0rc1
 Summary: Common task classes used by the DKIST science data processing pipelines
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause
@@ -222,7 +222,7 @@ To run the tests locally, clone the repository and install the package in editab
 
 .. code-block:: bash
 
-    git clone git@bitbucket.org:dkistdc/dkist-processing-common.git
+    git clone git@ssh.bitbucket.org:dkistdc/dkist-processing-common.git
     cd dkist-processing-common
     pre-commit install
     pip install -e .[test]

{dkist_processing_common-14.6.1 → dkist_processing_common-14.7.0rc1}/README.rst

@@ -157,7 +157,7 @@ To run the tests locally, clone the repository and install the package in editab
 
 .. code-block:: bash
 
-    git clone git@bitbucket.org:dkistdc/dkist-processing-common.git
+    git clone git@ssh.bitbucket.org:dkistdc/dkist-processing-common.git
     cd dkist-processing-common
     pre-commit install
     pip install -e .[test]

dkist_processing_common-14.7.0rc1/changelog/350.misc.rst

@@ -0,0 +1 @@
+Convert polcal and solar calibration quality metrics to the new storage-based QualityMetric framework.

dkist_processing_common-14.7.0rc1/changelog/356.doc.rst

@@ -0,0 +1 @@
+Update the README clone command to use Bitbucket's new SSH hostname.

{dkist_processing_common-14.6.1 → dkist_processing_common-14.7.0rc1}/dkist_processing_common/models/quality.py

@@ -19,129 +19,7 @@ from pydantic_core.core_schema import SerializationInfo
 from pydantic_core.core_schema import ValidationInfo
 
 ###########################################################
-# Old Quality Models                                      #
-#                                                         #
-# These will gradually be replaced by                    #
-# New Quality Models (below)                              #
-###########################################################
-
-
-class Plot2D(BaseModel):
-    """Support class use to hold the data for creating a 2D plot in the quality report."""
-
-    xlabel: str
-    ylabel: str
-    series_data: dict[str, list[list[Any]]]
-    series_name: str | None = None
-    ylabel_horizontal: bool = False
-    ylim: tuple[float, float] | None = None
-    plot_kwargs: dict[str, dict[str, Any]] = Field(default_factory=dict)
-    sort_series: bool = True
-
-
-class VerticalMultiPanePlot2D(BaseModel):
-    """
-    Support class to hold a multi-pane plot with plots stacked vertically.
-
-    This type of metric is really geared towards plots that share an X axis and have no gap between them. If you just
-    want two separate plots it's probably better to use a list of `Plot2D` objects.
-    """
-
-    top_to_bottom_plot_list: list[Plot2D]
-    match_x_axes: bool = True
-    no_gap: bool = True
-    top_to_bottom_height_ratios: list[float] | None = None
-
-    @field_validator("top_to_bottom_height_ratios")
-    @classmethod
-    def ensure_same_number_of_height_ratios_and_plots(
-        cls, height_ratios: list[float] | None, info: ValidationInfo
-    ) -> list[float]:
-        """
-        Make sure that the number of height ratios is the same as the number of plots.
-
-        Also populates default, same-size ratios if no ratios were given.
-        """
-        try:
-            plot_list = info.data["top_to_bottom_plot_list"]
-        except KeyError:
-            # The plot list didn't validate for some reason. We're about to error anyway.
-            return [1.0]
-
-        num_plots = len(plot_list)
-        if height_ratios is None:
-            return [1.0] * num_plots
-
-        if len(height_ratios) != num_plots:
-            raise ValueError(
-                f"The number of items in `top_to_bottom_height_ratios` list ({len(height_ratios)}) is not "
-                f"the same as the number of plots ({num_plots})"
-            )
-
-        return height_ratios
-
-
-class SimpleTable(BaseModel):
-    """Support class to hold a simple table to be inserted into the quality report."""
-
-    rows: list[list[Any]]
-    header_row: bool = True
-    header_column: bool = False
-
-
-class ModulationMatrixHistograms(BaseModel):
-    """Support class for holding the big ol' grid of histograms that represent the modulation matrix fits."""
-
-    modmat_list: list[list[list[float]]]
-
-
-class EfficiencyHistograms(BaseModel):
-    """Support class for holding 4 histograms that correspond to efficiencies of the 4 stokes components."""
-
-    efficiency_list: list[list[float]]
-
-
-class PlotHistogram(BaseModel):
-    """Support class to hold 1D data for plotting a histogram."""
-
-    xlabel: str
-    series_data: dict[str, list[float]]
-    series_name: str | None = None
-    vertical_lines: dict[str, float] | None
-
-
-class PlotRaincloud(BaseModel):
-    """Support class to hold data series for fancy-ass violin plots."""
-
-    xlabel: str
-    ylabel: str
-    categorical_column_name: str
-    distribution_column_name: str
-    dataframe_json: str
-    hue_column_name: str | None
-    ylabel_horizontal: bool | None
-
-
-class ReportMetric(BaseModel):
-    """A Quality Report is made up of a list of metrics with the schema defined by this class."""
-
-    name: str
-    description: str
-    metric_code: str
-    facet: str | None = None
-    statement: str | list[str] | None = None
-    plot_data: Plot2D | list[Plot2D] | 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
-    efficiency_data: EfficiencyHistograms | None = None
-    raincloud_data: PlotRaincloud | None = None
-    warnings: list[str] | None = None
-
-
-###########################################################
-# New Quality Models                                      #
+# Quality Models                                          #
 #                                                         #
 # These define the interface with dkist-quality           #
 # These will eventually get moved to dkist-quality        #
@@ -424,29 +302,34 @@ class MultiPlotData(QualityModel):
 class HistogramData(QualityModel):
     """Histogram Data."""
 
-    # TBD
-    pass
+    xlabel: str
+    series_data: dict[str, tuple[FiniteFloat, ...]] = Field(default_factory=dict)
+    series_name: str | None = None
+    vertical_lines: dict[str, FiniteFloat] | None = None
 
 
 class ModMatData(QualityModel):
     """Modulation Matrix Data."""
 
-    # TBD
-    pass
+    modmat_list: tuple[tuple[tuple[FiniteFloat, ...], ...], ...]
 
 
 class RaincloudData(QualityModel):
     """Raincloud Data."""
 
-    # TBD
-    pass
+    xlabel: str
+    ylabel: str
+    categorical_column_name: str
+    distribution_column_name: str
+    dataframe_json: str
+    hue_column_name: str | None = None
+    ylabel_horizontal: bool | None = None
 
 
 class EfficiencyData(QualityModel):
     """Efficiency Data."""
 
-    # TBD
-    pass
+    efficiency_list: tuple[tuple[FiniteFloat, ...], ...]
 
 
 def format_facet(v: Any) -> Any:
@@ -477,9 +360,10 @@ class QualityMetric(QualityModel):
     multi_plot_data: MultiPlotData | None = None
     histogram_data: list[HistogramData] | None = None
     table_data: list[TableData] | None = None
-    modmat_data: list[ModMatData] | None = None
-    raincloud_data: list[RaincloudData] | None = None
-    efficiency_data: list[EfficiencyData] | None = None
+    # The following three metrics are not a list as the quality library does not support a list of these metrics
+    modmat_data: ModMatData | None = None
+    raincloud_data: RaincloudData | None = None
+    efficiency_data: EfficiencyData | None = None
     warnings: list[str] | None = None
 
 

{dkist_processing_common-14.6.1 → dkist_processing_common-14.7.0rc1}/dkist_processing_common/tasks/l1_output_data.py

@@ -160,25 +160,12 @@ class TransferL1Data(TransferDataBase, GlobusMixin):
 class AssembleQualityData(L1OutputDataBase, QualityMixin):
     """Assemble quality data from the various quality metrics."""
 
-    @property
-    def polcal_label_list(self) -> list[str] | None:
-        """Return the list of labels to look for when building polcal metrics.
-
-        If no labels are specified then no polcal metrics will be built.
-        """
-        return None
-
     def run(self):
         """Run method for the task."""
-        # this is the new way, which will eventually supplant the old `quality_assemble_data`
         with self.telemetry_span("Assembling generic quality data"):
             self.compute_and_write_type_counts()
             quality_data = self.assemble_quality_data()
 
-        # this is the old way, which is being replaced by the new `assemble_quality_data`
-        with self.telemetry_span("Assembling quality data by Metric"):
-            quality_data += self.quality_assemble_data(polcal_label_list=self.polcal_label_list)
-
         with self.telemetry_span(
             f"Saving quality data with {len(quality_data)} metrics to the file system"
         ):