shepherd-core 2024.4.2__py3-none-any.whl → 2024.7.1__py3-none-any.whl

shepherd_core/__init__.py

@@ -23,7 +23,7 @@ from .testbed_client.client import TestbedClient
 from .testbed_client.client import tb_client
 from .writer import Writer
 
-__version__ = "2024.4.2"
+__version__ = "2024.7.1"
 
 __all__ = [
     "Reader",

shepherd_core/data_models/base/cal_measurement.py

@@ -16,8 +16,6 @@ from .calibration import CalibrationPair
 from .calibration import CapeData
 from .shepherd import ShpModel
 
-# TODO: move to shepherd_data to remove scipy-dependency from _core
-
 
 class CalMeasurementPair(ShpModel):
     """Value-container for a calibration-measurement."""
@@ -32,17 +30,23 @@ CalMeasPairs = Annotated[List[CalMeasurementPair], Field(min_length=2)]
 @validate_call
 def meas_to_cal(data: CalMeasPairs, component: str) -> CalibrationPair:
     """Convert values from calibration-measurement to the calibration itself."""
-    from scipy import stats  # placed here due to massive delay
-
     x = np.empty(len(data))
     y = np.empty(len(data))
     for i, pair in enumerate(data):
         x[i] = pair.shepherd_raw
         y[i] = pair.reference_si
-    result = stats.linregress(x, y)
-    offset = float(result.intercept)
-    gain = float(result.slope)
-    rval = result.rvalue  # test quality of regression
+
+    model = np.polyfit(x, y, 1)
+    offset = model[1]
+    gain = model[0]
+
+    # r-squared, Pearson correlation coefficient
+    p = np.poly1d(model)
+    yhat = p(x)
+    ybar = np.sum(y) / len(y)
+    ssreg = np.sum((yhat - ybar) ** 2)
+    sstot = np.sum((y - ybar) ** 2)
+    rval = ssreg / sstot
 
     if rval < 0.999:
         msg = (

shepherd_core/data_models/base/calibration.py

@@ -71,6 +71,7 @@ class CalibrationPair(ShpModel):
         if isinstance(values_raw, np.ndarray):
             values_raw[values_raw < 0.0] = 0.0
             values_raw = np.around(values_raw)
+            # TODO: overflow should also be prevented (add bit-width) -> fail or warn at both?
         else:
             values_raw = round(max(values_raw, 0.0))
         return values_raw

shepherd_core/data_models/task/emulation.py

@@ -60,7 +60,7 @@ class EmulationTask(ShpModel):
     # timestamp or unix epoch time, None = ASAP
     duration: Optional[timedelta] = None
     # ⤷ Duration of recording in seconds, None = till EOF
-    abort_on_error: bool = False
+    abort_on_error: bool = False  # TODO: remove, should not exist
 
     # emulation-specific
     use_cal_default: bool = False

shepherd_core/data_models/task/programming.py

@@ -43,7 +43,7 @@ class ProgrammingTask(ShpModel):
     def post_validation(self) -> Self:
         d_type = suffix_to_DType.get(self.firmware_file.suffix.lower())
         if d_type != FirmwareDType.base64_hex:
-            ValueError(f"Firmware is not intel-.hex ('{self.firmware_file}')")
+            raise ValueError("Firmware is not intel-.hex ('%s')", self.firmware_file.as_posix())
         return self
 
     @classmethod

shepherd_core/data_models/testbed/observer.py

@@ -70,11 +70,13 @@ class Observer(ShpModel, title="Shepherd-Sheep"):
         return self
 
     def has_target(self, target_id: int) -> bool:
-        if self.target_a is not None and target_id == self.target_a.id and self.target_a.active:
-            return True
-        if self.target_b is not None and target_id == self.target_b.id and self.target_b.active:
-            return True
-        return False
+        case_a = (
+            self.target_a is not None and target_id == self.target_a.id and self.target_a.active
+        )
+        case_b = (
+            self.target_b is not None and target_id == self.target_b.id and self.target_b.active
+        )
+        return case_a or case_b
 
     def get_target_port(self, target_id: int) -> TargetPort:
         if self.has_target(target_id):

shepherd_core/fw_tools/patcher.py

@@ -17,7 +17,7 @@ try:
 except ImportError as e:
     ELF = None
     elf_error_text = (
-        "Please install functionality with 'pip install shepherd_core[elf] -U' first, "
+        "Please install functionality with 'pip install shepherd-core[elf] -U' first, "
         f"underlying exception: {e.msg}"
     )
 

shepherd_core/fw_tools/validation.py

@@ -23,7 +23,7 @@ except ImportError as e:
     ELF = None
     ELFError = None
     elf_error_text = (
-        "Please install functionality with 'pip install shepherd_core[elf] -U' first, "
+        "Please install functionality with 'pip install shepherd-core[elf] -U' first, "
         f"underlying exception: {e.msg}"
     )
 
@@ -56,10 +56,9 @@ def is_hex_msp430(file: Path) -> bool:
         value = int.from_bytes(ih.gets(0xFFFE, 2), byteorder="little", signed=False)
         if 0x4000 > value >= 0xFF80:
             return False
-        if ih.get_memory_size() >= 270_000:
-            # conservative test for now - should be well below 128 kB + 8kB for msp430fr5962
-            return False
-        return True
+
+        # conservative test for now - should be well below 128 kB + 8kB for msp430fr5962
+        return ih.get_memory_size() <= 270_000
     return False
 
 
@@ -74,10 +73,9 @@ def is_hex_nrf52(file: Path) -> bool:
         ih = IntelHex(file.as_posix())
         if ih.minaddr() != 0x0000:
             return False
-        if ih.get_memory_size() >= 1310720:
-            # conservative test for now - should be well below 1 MB + 256 kB
-            return False
-        return True
+
+        # conservative test for now - should be well below 1 MB + 256 kB
+        return ih.get_memory_size() < 1310720
     return False
 
 

shepherd_core/inventory/system.py

@@ -3,8 +3,8 @@
 import platform
 import subprocess
 import time
-from contextlib import suppress
 from datetime import datetime
+from pathlib import Path
 from typing import Optional
 
 from typing_extensions import Self
@@ -48,6 +48,9 @@ class SystemInventory(ShpModel):
     #   ip IPvAnyAddress
     #   mac MACStr
 
+    fs_root: Optional[str] = None
+    beagle: Optional[str] = None
+
     model_config = ConfigDict(str_min_length=0)
 
     @classmethod
@@ -67,6 +70,31 @@ class SystemInventory(ShpModel):
             ifs2 = {name: (_if[1].address, _if[0].address) for name, _if in ifs1 if len(_if) > 1}
             uptime = time.time() - psutil.boot_time()
 
+        fs_cmd = ["/usr/bin/df", "-h", "/"]
+        fs_out = None
+        if Path(fs_cmd[0]).is_file():
+            reply = subprocess.run(  # noqa: S603
+                fs_cmd, timeout=30, capture_output=True, check=False
+            )
+            fs_out = str(reply.stdout)
+
+        beagle_cmd = ["/usr/bin/beagle-version"]
+        beagle_out = None
+        if Path(beagle_cmd[0]).is_file():
+            reply = subprocess.run(  # noqa: S603
+                beagle_cmd, timeout=30, capture_output=True, check=False
+            )
+            beagle_out = str(reply.stdout)
+
+        ptp_cmd = ["/usr/sbin/ptp4l", "-v"]
+        ptp_out = None
+        if Path(ptp_cmd[0]).is_file():
+            reply = subprocess.run(  # noqa: S603
+                ptp_cmd, timeout=30, capture_output=True, check=False
+            )
+            ptp_out = f"{ reply.stdout }, { reply.stderr }"
+            # alternative: check_output - seems to be lighter
+
         model_dict = {
             "uptime": round(uptime),
             "timestamp": ts,
@@ -77,12 +105,9 @@ class SystemInventory(ShpModel):
             "processor": platform.processor(),
             "hostname": platform.node(),
             "interfaces": ifs2,
-            # TODO: add free space on /
+            "fs_root": fs_out,
+            "beagle": beagle_out,
+            "ptp": ptp_out,
         }
 
-        with suppress(FileNotFoundError):
-            ret = subprocess.run(["/usr/sbin/ptp4l", "-v"], check=False)  # noqa: S603
-            model_dict["ptp"] = ret.stdout
-            # alternative: check_output - seems to be lighter
-
         return cls(**model_dict)

shepherd_core/reader.py

@@ -124,7 +124,10 @@ class Reader:
         if not hasattr(self, "_cal"):
             cal_dict = CalibrationSeries().model_dump()
             for ds, param in product(["current", "voltage", "time"], ["gain", "offset"]):
-                cal_dict[ds][param] = self.h5file["data"][ds].attrs[param]
+                try:
+                    cal_dict[ds][param] = self.h5file["data"][ds].attrs[param]
+                except KeyError:  # noqa: PERF203
+                    self._logger.debug("Cal-Param '%s' for dataset '%s' not found!", param, ds)
             self._cal = CalibrationSeries(**cal_dict)
 
         self._refresh_file_stats()
@@ -257,6 +260,8 @@ class Reader:
                 return EnergyDType[self.h5file["data"].attrs["datatype"]]
         except KeyError:
             return None
+        except ValueError:
+            return None
         else:
             return None
 
@@ -631,7 +636,7 @@ class Reader:
         Algo: create an offset-by-one vector and compare against original.
         """
         if len(data.shape) > 1:
-            ValueError("Array must be 1D")
+            raise ValueError("Array must be 1D")
         data_1 = np.concatenate(([not data[0]], data[:-1]))
         return data != data_1
 

shepherd_core/testbed_client/fixtures.py

@@ -168,9 +168,7 @@ def file_older_than(file: Path, delta: timedelta) -> bool:
     """Decide if file is older than a specific duration of time."""
     cutoff = local_now() - delta
     mtime = datetime.fromtimestamp(file.stat().st_mtime, tz=local_tz())
-    if mtime < cutoff:
-        return True
-    return False
+    return mtime < cutoff
 
 
 class Fixtures:

shepherd_core/writer.py

@@ -229,7 +229,7 @@ class Writer(Reader):
         """Initialize the structure of the HDF5 file.
 
         HDF5 is hierarchically structured and before writing data, we have to
-        setup this structure, i.e. creating the right groups with corresponding
+        set up this structure, i.e. creating the right groups with corresponding
         data types. We will store 3 types of data in a database: The
         actual IV samples recorded either from the harvester (during recording)
         or the target (during emulation). Any log messages, that can be used to
@@ -367,7 +367,7 @@ class Writer(Reader):
         TODO: use data-model?
         :param data: from virtual harvester or converter / source.
         """
-        self.h5file["data"].attrs["config"] = yaml.safe_dump(
+        self.h5file.attrs["config"] = yaml.safe_dump(
             data, default_flow_style=False, sort_keys=False
         )
 

{shepherd_core-2024.4.2.dist-info → shepherd_core-2024.7.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shepherd_core
-Version: 2024.4.2
+Version: 2024.7.1
 Summary: Programming- and CLI-Interface for the h5-dataformat of the Shepherd-Testbed
 Author-email: Ingmar Splitt <ingmar.splitt@tu-dresden.de>
 Maintainer-email: Ingmar Splitt <ingmar.splitt@tu-dresden.de>
@@ -33,7 +33,6 @@ Requires-Dist: numpy
 Requires-Dist: pyYAML
 Requires-Dist: chromalog
 Requires-Dist: pydantic[email] >2.0.0
-Requires-Dist: scipy
 Requires-Dist: tqdm
 Requires-Dist: intelhex
 Requires-Dist: requests

{shepherd_core-2024.4.2.dist-info → shepherd_core-2024.7.1.dist-info}/RECORD

@@ -1,15 +1,15 @@
-shepherd_core/__init__.py,sha256=TuaidDGnc0u0TfDIXiRUviqMXsRSL6ldy4AurQmr71U,1385
+shepherd_core/__init__.py,sha256=8FydSimdy6iX5N_ZPoxm2e4AEJLUg0wikCon87iqsj4,1385
 shepherd_core/calibration_hw_def.py,sha256=m5HDxHJ_blnn-C0Og5v6by1ApJRDT7RhytFbL-P5730,2548
 shepherd_core/commons.py,sha256=vymKXWcy_1bz7ChzzEATUkJ4p3czCzjIdsSehVjJOY8,218
 shepherd_core/logger.py,sha256=4Q4hTI-nccOZ1_A68fo4UEctfu3pJx3IeHfa9VuDDEo,1804
-shepherd_core/reader.py,sha256=qyc0MBHa-wMGRDglEaMtyB6OxCiODnOMJsxJH8NCcAo,26245
-shepherd_core/writer.py,sha256=VeW7AJsMKhfF06QsOjQ7Ez0gLq0NrrHUj2zq9_FtX6Y,14482
+shepherd_core/reader.py,sha256=dZt_q9PJt6FKBMfesk3wLfYdBp0EjCe_-gGZ-Gvd4tk,26473
+shepherd_core/writer.py,sha256=xcLCw-YokKaN8TrkwD0IjRmn8xZU0Q8wwWp_1K8JFVY,14475
 shepherd_core/data_models/__init__.py,sha256=IVjKbT2Ilz5bev325EvAuuhd9LfQgQ1u7qKo6dhVA2k,1866
 shepherd_core/data_models/readme.md,sha256=1bdfEypY_0NMhXLxOPRnLAsFca0HuHdq7_01yEWxvUs,2470
 shepherd_core/data_models/virtual_source_doc.txt,sha256=KizMcfGKj7BnHIbaJHT7KeTF01SV__UXv01qV_DGHSs,6057
 shepherd_core/data_models/base/__init__.py,sha256=PSJ6acWViqBm0Eiom8DIgKfFVrp5lzYr8OsDvP79vwI,94
-shepherd_core/data_models/base/cal_measurement.py,sha256=Ie35wWfH4spjETQ6SKHlbY_Ie2Bkt0dIQAKAn4ELOTc,3354
-shepherd_core/data_models/base/calibration.py,sha256=P2fCFzyrrXobkYQkBzqplpIlg5cDXKv0iWWrnaroq_I,10320
+shepherd_core/data_models/base/cal_measurement.py,sha256=YScPG7QLynbUHdjcznYqU8O5KRh0XiROGxGSk9BETMk,3357
+shepherd_core/data_models/base/calibration.py,sha256=HPhDEaApOCKxfX2q9RD8YCvA3Gqls-2bHqvLLvOM7kY,10415
 shepherd_core/data_models/base/content.py,sha256=13j7GSgT73xn27jgDP508thUEJR4U-nCb5n7CJ50c9Y,2463
 shepherd_core/data_models/base/shepherd.py,sha256=DNrx59o1VBuy_liJuUzZRzmTTYB73D_pUWiNyMQyjYY,6112
 shepherd_core/data_models/base/timezone.py,sha256=2T6E46hJ1DAvmqKfu6uIgCK3RSoAKjGXRyzYNaqKyjY,665
@@ -29,11 +29,11 @@ shepherd_core/data_models/experiment/experiment.py,sha256=QX3-oeBe5dRx1a_RHF6kxj
 shepherd_core/data_models/experiment/observer_features.py,sha256=qxnb7anuQz9ZW5IUlPdUXYPIl5U7O9uXkJqZtMnAb0Y,5156
 shepherd_core/data_models/experiment/target_config.py,sha256=XIsjbbo7yn_A4q3GMxWbiNzEGA0Kk5gH7-XfQQ7Kg0E,3674
 shepherd_core/data_models/task/__init__.py,sha256=rZLbgqX-dTWY4026-bqW-IWVHbA6C_xP9y0aeRze8FY,3374
-shepherd_core/data_models/task/emulation.py,sha256=75X8xkHx27LrBMntw-TaNGHbAN31_o0eby9kAeBopV8,6342
+shepherd_core/data_models/task/emulation.py,sha256=z3BEqERy2m3_rxqKo6w89sSnBQhFwHDEdCgwJh2XUOQ,6376
 shepherd_core/data_models/task/firmware_mod.py,sha256=Rw_TA1ykQ7abUd_U0snqZlpZyrS8Nx6f4BEax1Xnji0,2818
 shepherd_core/data_models/task/harvest.py,sha256=HHnqWwRsJupaZJxuohs7NrK6VaDyoRzGOaG2h9y3s1Y,3360
 shepherd_core/data_models/task/observer_tasks.py,sha256=XlH_-EGRrdodTn0c2pjGvpcauc0a9NOnLhysKw8iRwk,3511
-shepherd_core/data_models/task/programming.py,sha256=6Pmyeze2UxNyyDUACbIL18GzUCN9wn6PuGrYwA2h8VI,2305
+shepherd_core/data_models/task/programming.py,sha256=Mg9_AZHIdG01FheEJAifIRPSB3iZ0UJITf8zeg2jyws,2323
 shepherd_core/data_models/task/testbed_tasks.py,sha256=yU4YhNN1ObYkcts7UOwkWWhCmW67f_Gjx3dhvzMnKWI,2036
 shepherd_core/data_models/testbed/__init__.py,sha256=cL3swgijyIpZIW1vl51OVR2seAlWt6Ke9oB_cBkPniU,612
 shepherd_core/data_models/testbed/cape.py,sha256=D23ZKXpZRPIIOMn6LCoJrwHiRbSaYg-y7B6fAt1ap64,1246
@@ -42,7 +42,7 @@ shepherd_core/data_models/testbed/gpio.py,sha256=m4U8-KotpZbdSkRkXm2GqoADiubr_1-
 shepherd_core/data_models/testbed/gpio_fixture.yaml,sha256=yXvoXAau2hancKi2yg1xIkErPWQa6gIxNUG3y8JuF9Y,3076
 shepherd_core/data_models/testbed/mcu.py,sha256=pUyT8gwPcqh18I7FC6iE6gYYISo69TvDfuq2zSwfmxs,1375
 shepherd_core/data_models/testbed/mcu_fixture.yaml,sha256=lRZMLs27cTeERSFGkbMt5xgxbn11Gh9G1mQqOZK136I,522
-shepherd_core/data_models/testbed/observer.py,sha256=AezYNm9mW5WCdxm5TXT-UQUwIhKDHchMIugsLGy1PMA,3225
+shepherd_core/data_models/testbed/observer.py,sha256=hlj6buDzUQKYnlhCJZyxnrAPYKoL4zq9y14sKtYofOU,3246
 shepherd_core/data_models/testbed/observer_fixture.yaml,sha256=w4VS6lTzaVs5IqWjkHanxcjDhIEydQPCV6z_DlsLFqA,4812
 shepherd_core/data_models/testbed/target.py,sha256=KeJaLradQ3oHeeowCg_X0lDHDqyi3R3La0YPKC5Rv90,1838
 shepherd_core/data_models/testbed/target_fixture.yaml,sha256=6YbCV3aTtDUKzC40kPURq9nFwTjT97LNy7imOb_35sk,3668
@@ -53,23 +53,23 @@ shepherd_core/decoder_waveform/uart.py,sha256=sHsXHOsDU1j9zMSZO7CCMTMinT4U_S5Ngs
 shepherd_core/fw_tools/__init__.py,sha256=_RZpgHsNN1Zhd-x0-A9aJPI3pjULKhR9iuR9eKPa8zQ,2137
 shepherd_core/fw_tools/converter.py,sha256=3igRT33tghrBCao5njuPmePS-Y_lSa6EUHvwCakMo2s,3539
 shepherd_core/fw_tools/converter_elf.py,sha256=GQDVqIqMW4twNMvZIV3sowFMezhs2TN-IYREjRP7Xt4,1089
-shepherd_core/fw_tools/patcher.py,sha256=ODBADQeomah0NadIuGSAwMVlafOf_KAnz_IMvDgydVE,4108
-shepherd_core/fw_tools/validation.py,sha256=2AnBpl5MpW8C-uLlusNZWJRDHa7lG7sB2pB1GKhTMcY,4790
+shepherd_core/fw_tools/patcher.py,sha256=D6MHaCvKRRVQYSZozODAp_l7UnqxVsvnulPzpkfXWW8,4108
+shepherd_core/fw_tools/validation.py,sha256=hBLCKIUumPTA6iuXMVbMYph2jamaxeSTxRqsvl3C4-I,4699
 shepherd_core/inventory/__init__.py,sha256=nRO11HG4eJ_FaXebSkE0dd1H6qvjrX5n3OQHOzKXVvk,3841
 shepherd_core/inventory/python.py,sha256=OWNnyEt0IDPW9XGW-WloU0FExwgZzYNA05VpRj4cZGc,1250
-shepherd_core/inventory/system.py,sha256=hmUuaeg6_6Xsykp47YAtTeUbDa5B8sxV0EICQJG9rx4,2304
+shepherd_core/inventory/system.py,sha256=GScfYZm0dlWQv4Np6R1JI_XGHVcECAw50Wqef_hW3VU,3121
 shepherd_core/inventory/target.py,sha256=Lq11j25tWieXheOxIDaQb-lc-2omxYVex5P6uGiLUyk,507
 shepherd_core/testbed_client/__init__.py,sha256=lzi7F5Go-AsbTbiUCf9Rnu6pzmTZqmpIqoS1yCPal_c,175
 shepherd_core/testbed_client/cache_path.py,sha256=tS0er9on5fw8wddMCt1jkc2uyYOdSTvX_UmfmYJf6tY,445
 shepherd_core/testbed_client/client.py,sha256=3vbJ9XdWe9YA28AXgzXThHJtYJU5RUUCpDRBH1mDIr8,5917
-shepherd_core/testbed_client/fixtures.py,sha256=db10P0c6kJvG525mLZYuFE98kI0PvoA67jeJgCiUaZ4,9782
+shepherd_core/testbed_client/fixtures.py,sha256=TDRVtxorJ5IFlFwwVcSDpAm1g51ok1PPMt1WmdBpzaM,9748
 shepherd_core/testbed_client/user_model.py,sha256=5M3vWkAGBwdGDUYAanAjrZwpzMBlh3XLOVvNYWiLmms,2107
 shepherd_core/vsource/__init__.py,sha256=dS33KYLq5GQ9_D8HfdP8iWSocWTghCi2ZZG2AJWNfaM,391
 shepherd_core/vsource/virtual_converter_model.py,sha256=ZSoWVLfRmFEjeCNoQCg3BctzhdfayINUBDU_AJK1CR0,10404
 shepherd_core/vsource/virtual_harvester_model.py,sha256=wCbFfsqDRC5Rfu8qANkmkP9XGJOPHJY9-iSnI850JI4,7817
 shepherd_core/vsource/virtual_source_model.py,sha256=fjN8myTY3I_LpikF_aGAcxes3RGu1GP23P7XKC_UIyA,2737
-shepherd_core-2024.4.2.dist-info/METADATA,sha256=bC_TD-hytcffYDetSqElbilSIM77vvX8f8TjhyzXaCQ,7651
-shepherd_core-2024.4.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-shepherd_core-2024.4.2.dist-info/top_level.txt,sha256=wy-t7HRBrKARZxa-Y8_j8d49oVHnulh-95K9ikxVhew,14
-shepherd_core-2024.4.2.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-shepherd_core-2024.4.2.dist-info/RECORD,,
+shepherd_core-2024.7.1.dist-info/METADATA,sha256=KtwQxX6iIfqe3mvFb3ZLVZXS6Ovjy9Vh2K6nu5lxvy8,7630
+shepherd_core-2024.7.1.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
+shepherd_core-2024.7.1.dist-info/top_level.txt,sha256=wy-t7HRBrKARZxa-Y8_j8d49oVHnulh-95K9ikxVhew,14
+shepherd_core-2024.7.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+shepherd_core-2024.7.1.dist-info/RECORD,,

{shepherd_core-2024.4.2.dist-info → shepherd_core-2024.7.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: setuptools (70.2.0)
 Root-Is-Purelib: true
 Tag: py3-none-any