etlup 4.3.2__tar.gz → 4.3.3__tar.gz

{etlup-4.3.2 → etlup-4.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etlup
-Version: 4.3.2
+Version: 4.3.3
 Summary: Test definitions, plotting and documentation for the CMS MTD ETL project
 Author: Hayden Swanson
 Author-email: Hayden Swanson <hayden.swanson@cern.ch>

{etlup-4.3.2 → etlup-4.3.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "etlup"
-version = "4.3.2"
+version = "4.3.3"
 description = "Test definitions, plotting and documentation for the CMS MTD ETL project"
 readme = "README.md"
 requires-python = ">=3.8"

etlup-4.3.3/src/etlup/module/ModuleIV.py

@@ -0,0 +1,147 @@
+from pydantic import ConfigDict, Field, model_validator
+from typing_extensions import Union, Annotated, Literal, List, Optional
+import matplotlib.pyplot as plt
+import numpy as np
+from .. import base_model as bm, jinja_env
+from ..custom_types import Image
+from ..plot_utils import convert_fig_to_html_img, image_src
+
+# A 1x1 PNG, just enough for the example below to be a real image.
+_EXAMPLE_IMAGE = (
+    "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAAAAAA6fptVAAAACklEQVR4nGO4AAAA0gDR29kOtwAAAABJRU5ErkJggg=="
+)
+
+class ModuleIVV0(bm.ConstructionBase):
+    model_config = ConfigDict(json_schema_extra={
+        'examples': [
+            {
+                "module": "MV4002",
+                "component_pos": 2,
+                "name": "module iv",
+                "measurement_date": "2023-01-01T12:00:00+01:00",
+                "location": "BU",
+                "user_created": "hayden",
+                "version": "v0",
+                "current":  [0,1,2,3,4,5],
+                "voltage":  [0,1,2,3,4,5],
+                "k_factor": [0,1,2,3,4,5],
+                "classification": "good",
+                "comment": "Breakdown well above the operating voltage.",
+            },
+            {
+                "module": "MV4001",
+                "component_pos": 0,
+                "name": "module iv",
+                "measurement_date": "2023-01-01T12:00:00+01:00",
+                "location": "BU",
+                "user_created": "hayden",
+                "version": "v0",
+                "legacy_image_if_no_data": _EXAMPLE_IMAGE,
+                "comment": "Raw data lost, only the plot was kept.",
+            },
+        ],
+        'table': 'test',
+        'category': 'Module',
+        'module_types': [],
+        'component_types': [],
+        'description': (
+            'IV curve of a sensor on a module, classified as good, bad or weird (good when not given), '
+            'optionally with a comment. '
+            'Send current and voltage whenever you have them. legacy_image_if_no_data is only for '
+            'measurements whose raw data is gone and only a picture of the curve is left; it cannot '
+            'be sent together with current and voltage.'
+        )
+    })
+    name: Literal['module iv'] = "module iv"
+    version: Literal["v0"] = "v0"
+
+    module: str
+    component_pos: int = Field(ge=0, le=3, description="Component position (0-3)")
+    
+    # Current and voltage are the measurement and should always be sent. They are only optional so
+    # that a measurement whose raw data was lost can still be recorded with legacy_image_if_no_data.
+    current: Optional[List[float]] = None
+    voltage: Optional[List[float]] = None
+    k_factor: Union[None, List[float]] = None
+    classification: Literal['good', 'bad', 'weird'] = 'good'
+    comment: Optional[str] = None
+    # Last resort, do not use if you have the data: a picture of the IV curve, for old measurements
+    # whose current and voltage no longer exist.
+    legacy_image_if_no_data: Optional[Image] = None
+
+    @model_validator(mode='after')
+    def data_or_legacy_image(self):
+        """Either the measurement itself, or, only when it is gone, a picture of it."""
+        has_data = self.current is not None or self.voltage is not None
+        if self.legacy_image_if_no_data is not None:
+            if has_data or self.k_factor is not None:
+                raise ValueError('legacy_image_if_no_data is only for measurements whose data is gone. You sent current, voltage or k_factor, so send those and leave the image out.')
+        elif self.current is None or self.voltage is None:
+            raise ValueError('Both current and voltage are required.')
+        return self
+
+    @model_validator(mode='after')
+    def same_lengths(self):
+        if self.current is not None and self.voltage is not None:
+            if len(self.current) != len(self.voltage):
+                raise ValueError(f'Current and voltage arrays should have the same lengths. Length of Current, Length of Voltage = ({len(self.current)}, {len(self.voltage)})')
+        if self.k_factor is not None and self.current is not None:
+            if len(self.k_factor) != len(self.current):
+                raise ValueError(f'k_factor and current arrays should have the same lengths. Length of k_factor, Length of Current = ({len(self.k_factor)}, {len(self.current)})')
+        return self
+
+    def plot(self):
+        if self.current is None:  # only a legacy image, nothing to plot
+            return None
+        fig, ax = plt.subplots(figsize=(6, 4))
+        ax.plot(self.voltage, self.current, marker='o', label='IV Curve')
+
+        if self.k_factor is None:
+            plot_k_factor = [np.nan]
+            for i in range(1, len(self.current)):
+                delta_v = self.voltage[i] - self.voltage[i - 1]
+                current_i = self.current[i]
+                current_prev = self.current[i - 1]
+
+                if delta_v == 0 or current_i == 0:
+                    plot_k_factor.append(np.nan)
+                    continue
+
+                k_val = ((current_i - current_prev) / delta_v) * (self.voltage[i] / current_i)
+                plot_k_factor.append(k_val)
+        else:
+            plot_k_factor = self.k_factor
+
+        ax2 = ax.twinx()
+        ax2.plot(self.voltage, plot_k_factor, marker='x', linestyle='--', color='orange', label='k_factor')
+        ax2.set_ylabel('k_factor')
+
+        ax.set_xlabel('Voltage (V)')
+        ax.set_ylabel('Current (A)')
+        ax.set_title(f'Module {self.module} - Component {self.component_pos}')
+        ax.grid(True)
+        handles1, labels1 = ax.get_legend_handles_labels()
+        handles2, labels2 = ax2.get_legend_handles_labels()
+        ax.legend(handles1 + handles2, labels1 + labels2, loc='best')
+        return fig
+    
+    def html_display(self):
+        display_data = {
+            "classification": self.classification,
+            "comment": self.comment,
+        }
+        if self.legacy_image_if_no_data is not None:
+            plot = (
+                f'<p>Legacy image, the raw data for this measurement is no longer available.</p>'
+                f'<img src="{image_src(self.legacy_image_if_no_data)}" alt="{self.module} IV curve" '
+                'style="width: clamp(300px, 75vw, 1000px); height: auto;">'
+            )
+        else:
+            plot = convert_fig_to_html_img(self.plot())
+        template = jinja_env.get_template('sensors_plot.html')
+        return template.render(
+            plot=plot,
+            display_data=display_data
+        )
+    
+ModuleIVType = Annotated[Union[ModuleIVV0], Field(discriminator="version")]

etlup-4.3.3/src/etlup/readout_board/ProbingTest.py

@@ -0,0 +1,129 @@
+from pydantic import ConfigDict, Field
+from typing_extensions import Annotated, Literal, Union, Optional
+
+from .. import base_model as bm
+
+# The rails probed on the board, as field name -> (the column it is under on the probing sheet, unit),
+# in the order they are displayed.
+_RAILS = {
+    'r2p': ('R2P', 'kOhm'),
+    'lv_rb': ('LV_RB', 'V'),
+    'rb_1v2': ('1V2_RB', 'V'),
+    'tx_2v5': ('2.5VTX', 'V'),
+    'rx_2v5': ('2.5VRX', 'V'),
+}
+# Each of the three slots has four reference voltages, held as slot_<slot>_vref_<vref>.
+_SLOTS = range(3)
+_VREFS = range(4)
+
+def _show(value) -> str:
+    """A probed value as it reads in the display, a dash when it was not probed."""
+    return '&mdash;' if value is None else str(value)
+
+class ProbingTestV0(bm.ConstructionBase):
+    model_config = ConfigDict(json_schema_extra={
+        'examples': [
+            {
+                "component": "RB0001",
+                "name": "readout_board_probing",
+                "location": "BU",
+                "user_created": "hayden",
+                "version": "v0",
+                "measurement_date": "2026-11-10T12:01:00+01:00",
+                "r2p": 100.1,
+                "lv_rb": 9.1,
+                "rb_1v2": 1.199,
+                "tx_2v5": 2.509,
+                "rx_2v5": 2.617,
+                "slot_0_vref_0": 0.996,
+                "slot_0_vref_1": 0.996,
+                "slot_0_vref_2": 0.997,
+                "slot_0_vref_3": 0.998,
+                "slot_1_vref_0": 0.996,
+                "slot_1_vref_1": 0.995,
+                "slot_1_vref_2": 0.995,
+                "slot_1_vref_3": 0.996,
+                "slot_2_vref_0": 0.996,
+                "slot_2_vref_1": 0.996,
+                "slot_2_vref_2": 0.996,
+                "slot_2_vref_3": 0.995,
+            },
+            {
+                "component": "RB0002",
+                "name": "readout_board_probing",
+                "location": "BU",
+                "user_created": "hayden",
+                "version": "v0",
+                "measurement_date": "2026-11-10T12:05:00+01:00",
+                "r2p": 99.4,
+                "lv_rb": 9.1,
+                "rb_1v2": 1.198,
+                "tx_2v5": 2.558,
+                "rx_2v5": 2.573,
+            },
+        ],
+        'table': 'test',
+        'category': 'Readout Board',
+        'component_types': [],
+        'module_types': [],
+        'description': (
+            'Probing of the test points on a readout board: R2P in kOhm, the LV_RB, 1V2_RB, 2.5VTX '
+            'and 2.5VRX rails in V, and the four reference voltages (VREF0-3) of each of the three '
+            'slots in V. Every test point is optional, so only what was probed needs to be sent.'
+        )
+    })
+
+    name: Literal['readout_board_probing'] = 'readout_board_probing'
+    version: Literal["v0"] = "v0"
+    component: str
+
+    r2p: Optional[float] = Field(None, description='R2P, in kOhm')
+    lv_rb: Optional[float] = Field(None, description='LV_RB, in V')
+    rb_1v2: Optional[float] = Field(None, description='1V2_RB, in V')
+    tx_2v5: Optional[float] = Field(None, description='2.5VTX, in V')
+    rx_2v5: Optional[float] = Field(None, description='2.5VRX, in V')
+
+    # SLOT_<slot>_VREF<vref> on the probing sheet, in V.
+    slot_0_vref_0: Optional[float] = None
+    slot_0_vref_1: Optional[float] = None
+    slot_0_vref_2: Optional[float] = None
+    slot_0_vref_3: Optional[float] = None
+    slot_1_vref_0: Optional[float] = None
+    slot_1_vref_1: Optional[float] = None
+    slot_1_vref_2: Optional[float] = None
+    slot_1_vref_3: Optional[float] = None
+    slot_2_vref_0: Optional[float] = None
+    slot_2_vref_1: Optional[float] = None
+    slot_2_vref_2: Optional[float] = None
+    slot_2_vref_3: Optional[float] = None
+
+    def plot(self):
+        return None
+
+    def html_display(self) -> str:
+        rail_head = ''.join(f'<th>{label} ({unit})</th>' for label, unit in _RAILS.values())
+        rail_values = ''.join(f'<td>{_show(getattr(self, field))}</td>' for field in _RAILS)
+        vref_head = ''.join(f'<th>VREF{vref} (V)</th>' for vref in _VREFS)
+        vref_rows = ''.join(
+            f'<tr><th>Slot {slot}</th>'
+            + ''.join(f'<td>{_show(getattr(self, f"slot_{slot}_vref_{vref}"))}</td>' for vref in _VREFS)
+            + '</tr>'
+            for slot in _SLOTS
+        )
+        return f"""
+        <div class="table-responsive my-3">
+            <table class="table table-bordered table-sm w-auto mx-auto">
+                <thead><tr>{rail_head}</tr></thead>
+                <tbody><tr>{rail_values}</tr></tbody>
+            </table>
+        </div>
+        <div class="table-responsive my-3">
+            <table class="table table-bordered table-sm w-auto mx-auto">
+                <thead><tr><th></th>{vref_head}</tr></thead>
+                <tbody>{vref_rows}</tbody>
+            </table>
+        </div>
+        """
+
+
+ProbingTestType = Annotated[Union[ProbingTestV0], Field(discriminator="version")]

{etlup-4.3.2 → etlup-4.3.3}/src/etlup/sensor/SensorIV.py

@@ -4,6 +4,10 @@ import matplotlib.pyplot as plt
 from ..plot_utils import convert_fig_to_html_img
 from .. import base_model, jinja_env
 
+def _two_places(value):
+    """A float as it is displayed, with 2 decimal places."""
+    return None if value is None else f'{value:.2f}'
+
 class SensorIVV0(base_model.ConstructionBase):
     model_config = ConfigDict(json_schema_extra={
         'examples': [
@@ -54,7 +58,7 @@ class SensorIVV0(base_model.ConstructionBase):
         if self.voltage is not None and self.current is not None:
             ax.plot(self.voltage, self.current, label='IV Curve', marker='o')
             if self.breakdown_voltage_V is not None:
-                ax.axvline(x=self.breakdown_voltage_V, color='green', linestyle='--', label=f'Breakdown Voltage: {self.breakdown_voltage_V} V')
+                ax.axvline(x=self.breakdown_voltage_V, color='green', linestyle='--', label=f'Breakdown Voltage: {_two_places(self.breakdown_voltage_V)} V')
             ax.set_xlabel('Voltage (V)')
             ax.set_ylabel('Current (A)')
             if self.category is not None:
@@ -68,8 +72,8 @@ class SensorIVV0(base_model.ConstructionBase):
 
     def html_display(self):
         display_data = {
-            "leakage_current_uA": self.leakage_current_uA,
-            "breakdown_voltage_V": self.breakdown_voltage_V,
+            "leakage_current_uA": _two_places(self.leakage_current_uA),
+            "breakdown_voltage_V": _two_places(self.breakdown_voltage_V),
             "category": self.category,
             "gain_category": self.gain_category
         }

etlup-4.3.2/src/etlup/module/ModuleIV.py

@@ -1,87 +0,0 @@
-from pydantic import ConfigDict, Field, model_validator
-from typing_extensions import Union, Annotated, Literal, List
-import matplotlib.pyplot as plt
-import numpy as np
-from .. import base_model as bm
-from ..plot_utils import convert_fig_to_html_img
-
-class ModuleIVV0(bm.ConstructionBase):
-    model_config = ConfigDict(json_schema_extra={
-        'examples': [
-            {
-                "module": "MV4002",
-                "component_pos": 2,
-                "name": "module iv",
-                "measurement_date": "2023-01-01T12:00:00+01:00",
-                "location": "BU",
-                "user_created": "hayden",
-                "version": "v0",
-                "current":  [0,1,2,3,4,5],
-                "voltage":  [0,1,2,3,4,5],
-                "k_factor": [0,1,2,3,4,5]
-            },
-        ],
-        'table': 'test',
-        'category': 'Module',
-        'module_types': [],
-        'component_types': [],
-        'description': 'IV curve of a sensor on a module.'
-    })
-    name: Literal['module iv'] = "module iv"
-    version: Literal["v0"] = "v0"
-
-    module: str
-    component_pos: int = Field(ge=0, le=3, description="Component position (0-3)")
-    
-    current: List[float]
-    voltage: List[float]
-    k_factor: Union[None, List[float]] = None
-
-    @model_validator(mode='after')
-    def same_lengths(self):
-        if self.current is not None and self.voltage is not None:
-            if len(self.current) != len(self.voltage):
-                raise ValueError(f'Current and voltage arrays should have the same lengths. Length of Current, Length of Voltage = ({len(self.current)}, {len(self.voltage)})')
-        if self.k_factor is not None and self.current is not None:
-            if len(self.k_factor) != len(self.current):
-                raise ValueError(f'k_factor and current arrays should have the same lengths. Length of k_factor, Length of Current = ({len(self.k_factor)}, {len(self.current)})')
-        return self
-
-    def plot(self):
-        fig, ax = plt.subplots(figsize=(6, 4))
-        ax.plot(self.voltage, self.current, marker='o', label='IV Curve')
-
-        if self.k_factor is None:
-            plot_k_factor = [np.nan]
-            for i in range(1, len(self.current)):
-                delta_v = self.voltage[i] - self.voltage[i - 1]
-                current_i = self.current[i]
-                current_prev = self.current[i - 1]
-
-                if delta_v == 0 or current_i == 0:
-                    plot_k_factor.append(np.nan)
-                    continue
-
-                k_val = ((current_i - current_prev) / delta_v) * (self.voltage[i] / current_i)
-                plot_k_factor.append(k_val)
-        else:
-            plot_k_factor = self.k_factor
-
-        ax2 = ax.twinx()
-        ax2.plot(self.voltage, plot_k_factor, marker='x', linestyle='--', color='orange', label='k_factor')
-        ax2.set_ylabel('k_factor')
-
-        ax.set_xlabel('Voltage (V)')
-        ax.set_ylabel('Current (A)')
-        ax.set_title(f'Module {self.module} - Component {self.component_pos}')
-        ax.grid(True)
-        handles1, labels1 = ax.get_legend_handles_labels()
-        handles2, labels2 = ax2.get_legend_handles_labels()
-        ax.legend(handles1 + handles2, labels1 + labels2, loc='best')
-        return fig
-    
-    def html_display(self):
-        fig = self.plot()
-        return convert_fig_to_html_img(fig)
-    
-ModuleIVType = Annotated[Union[ModuleIVV0], Field(discriminator="version")]