shepherd-core 2024.11.2__tar.gz → 2025.2.1__tar.gz

{shepherd_core-2024.11.2 → shepherd_core-2025.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: shepherd_core
-Version: 2024.11.2
+Version: 2025.2.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>

{shepherd_core-2024.11.2 → shepherd_core-2025.2.1}/shepherd_core/data_models/content/virtual_harvester.py

@@ -239,6 +239,7 @@ class HarvesterPRUConfig(ShpModel):
         data: VirtualHarvesterConfig,
         dtype_in: Optional[EnergyDType] = EnergyDType.ivsample,
         window_size: Optional[u32] = None,
+        voltage_step_V: Optional[float] = None,
         *,
         for_emu: bool = False,
     ) -> Self:
@@ -247,17 +248,36 @@ class HarvesterPRUConfig(ShpModel):
         if for_emu and dtype_in not in {EnergyDType.ivsample, EnergyDType.ivcurve}:
             raise NotImplementedError
 
+        if for_emu and dtype_in == EnergyDType.ivcurve and voltage_step_V is None:
+            raise ValueError(
+                "For correct emulation specify voltage_step used by harvester "
+                "e.g. via file_src.get_voltage_step()"
+            )
+
+        if for_emu and dtype_in == EnergyDType.ivcurve and window_size is None:
+            raise ValueError(
+                "For correct emulation specify window_size used by harvester "
+                "e.g. via file_src.get_window_size()"
+            )
+
         interval_ms, duration_ms = data.calc_timings_ms(for_emu=for_emu)
+        window_size = (
+            window_size
+            if window_size is not None
+            else data.calc_window_size(dtype_in, for_emu=for_emu)
+        )
+        voltage_step_mV = (
+            1e3 * voltage_step_V if voltage_step_V is not None else data.voltage_step_mV
+        )
+
         return cls(
             algorithm=data.calc_algorithm_num(for_emu=for_emu),
             hrv_mode=data.calc_hrv_mode(for_emu=for_emu),
-            window_size=window_size
-            if window_size is not None
-            else data.calc_window_size(dtype_in, for_emu=for_emu),
+            window_size=window_size,
             voltage_uV=round(data.voltage_mV * 10**3),
             voltage_min_uV=round(data.voltage_min_mV * 10**3),
             voltage_max_uV=round(data.voltage_max_mV * 10**3),
-            voltage_step_uV=round(data.voltage_step_mV * 10**3),
+            voltage_step_uV=round(voltage_step_mV * 10**3),
             current_limit_nA=round(data.current_limit_uA * 10**3),
             setpoint_n8=round(min(255, data.setpoint_n * 2**8)),
             interval_n=round(interval_ms * samplerate_sps_default * 1e-3),

{shepherd_core-2024.11.2 → shepherd_core-2025.2.1}/shepherd_core/data_models/task/__init__.py

@@ -59,8 +59,7 @@ def prepare_task(config: Union[ShpModel, Path, str], observer: Optional[str] = N
     if shp_wrap.datatype == TestbedTasks.__name__:
         if observer is None:
             logger.debug(
-                "Task-Set contained TestbedTasks & no observer was provided "
-                "-> will return TB-Tasks"
+                "Task-Set contained TestbedTasks & no observer was provided -> will return TB-Tasks"
             )
             return shp_wrap
         tbt = TestbedTasks(**shp_wrap.parameters)

{shepherd_core-2024.11.2 → shepherd_core-2025.2.1}/shepherd_core/inventory/system.py

@@ -93,7 +93,7 @@ class SystemInventory(ShpModel):
             reply = subprocess.run(  # noqa: S603
                 ptp_cmd, timeout=30, capture_output=True, check=False
             )
-            ptp_out = f"{ reply.stdout }, { reply.stderr }"
+            ptp_out = f"{reply.stdout}, {reply.stderr}"
             # alternative: check_output - seems to be lighter
 
         model_dict = {

{shepherd_core-2024.11.2 → shepherd_core-2025.2.1}/shepherd_core/reader.py

@@ -172,7 +172,10 @@ class Reader:
         """Update internal states, helpful after resampling or other changes in data-group."""
         self.h5file.flush()
         sample_count = self.ds_time.shape[0]
-        duration_raw = self.ds_time[sample_count - 1] - self.ds_time[0] if sample_count > 0 else 0
+        duration_raw = (
+            (int(self.ds_time[sample_count - 1]) - int(self.ds_time[0])) if sample_count > 0 else 0
+        )
+        # above's typecasting prevents overflow in u64-format
         if (sample_count > 0) and (duration_raw > 0):
             # this assumes iso-chronous sampling
             duration_s = self._cal.time.raw_to_si(duration_raw)
@@ -270,6 +273,29 @@ class Reader:
         else:
             return None
 
+    def get_voltage_step(self) -> Optional[float]:
+        """Informs about the voltage step (in volts) used during harvesting the ivcurve.
+
+        Options for figuring out the real step:
+        - look into config (if available)
+        - analyze recorded data for most often used delta
+        - calculate with 'steps_n * (1 + wait_cycles)' (done for calculating window_size)
+        """
+        voltage_step: Optional[float] = (
+            self.get_config().get("virtual_harvester", {}).get("voltage_step_mV", None)
+        )
+        if voltage_step is None:
+            dsv = self.ds_voltage[0:2000]
+            diffs_np = np.unique(dsv[1:] - dsv[0:-1], return_counts=False)
+            diffs_ls = [_e for _e in list(np.array(diffs_np)) if _e > 0]
+            # static voltages have 0 steps, so
+            if len(diffs_ls) == 0:
+                return None  # or is 0 better? that may provoke div0
+            voltage_step = min(diffs_ls)
+        if voltage_step is not None:
+            voltage_step = 1e-3 * voltage_step
+        return voltage_step
+
     def get_hrv_config(self) -> dict:
         """Essential info for harvester.
 
@@ -278,6 +304,7 @@ class Reader:
         return {
             "datatype": self.get_datatype(),
             "window_samples": self.get_window_samples(),
+            "voltage_step_V": self.get_voltage_step(),
         }
 
     def is_valid(self) -> bool:

{shepherd_core-2024.11.2 → shepherd_core-2025.2.1}/shepherd_core/testbed_client/client_web.py

@@ -36,7 +36,7 @@ class WebClient(AbcClient):
         super().__init__()
         if not hasattr(self, "_token"):
             # add default values
-            self._token: str = "basic_public_access"
+            self._token: str = "basic_public_access"  # noqa: S105
             self._server: str = testbed_server_default
             self._user: Optional[User] = None
             self._key: Optional[str] = None

{shepherd_core-2024.11.2 → shepherd_core-2025.2.1}/shepherd_core/version.py

@@ -1,3 +1,3 @@
 """Separated string avoids circular imports."""
 
-version: str = "2024.11.2"
+version: str = "2025.02.1"

{shepherd_core-2024.11.2 → shepherd_core-2025.2.1}/shepherd_core/vsource/virtual_harvester_simulation.py

@@ -47,6 +47,7 @@ def simulate_harvester(
         for_emu=True,
         dtype_in=file_inp.get_datatype(),
         window_size=file_inp.get_window_samples(),
+        voltage_step_V=file_inp.get_voltage_step(),
     )
     hrv = VirtualHarvesterModel(hrv_pru)
     e_out_Ws = 0.0

{shepherd_core-2024.11.2 → shepherd_core-2025.2.1}/shepherd_core/vsource/virtual_source_model.py

@@ -31,6 +31,7 @@ class VirtualSourceModel:
         cal_emu: CalibrationEmulator,
         dtype_in: EnergyDType = EnergyDType.ivsample,
         window_size: Optional[int] = None,
+        voltage_step_V: Optional[float] = None,
         *,
         log_intermediate: bool = False,
     ) -> None:
@@ -50,6 +51,7 @@ class VirtualSourceModel:
             for_emu=True,
             dtype_in=dtype_in,
             window_size=window_size,
+            voltage_step_V=voltage_step_V,
         )
 
         self.hrv: VirtualHarvesterModel = VirtualHarvesterModel(hrv_config)

{shepherd_core-2024.11.2 → shepherd_core-2025.2.1}/shepherd_core/vsource/virtual_source_simulation.py

@@ -56,6 +56,7 @@ def simulate_source(
         dtype_in=file_inp.get_datatype(),
         log_intermediate=False,
         window_size=file_inp.get_window_samples(),
+        voltage_step_V=file_inp.get_voltage_step(),
     )
     i_out_nA = 0
     e_out_Ws = 0.0

{shepherd_core-2024.11.2 → shepherd_core-2025.2.1}/shepherd_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: shepherd_core
-Version: 2024.11.2
+Version: 2025.2.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>

{shepherd_core-2024.11.2 → shepherd_core-2025.2.1}/tests/vsource/test_converter.py

@@ -26,6 +26,7 @@ def src_model(
     name: str,
     dtype_in: EnergyDType = EnergyDType.ivsample,
     window_size: Optional[int] = None,
+    voltage_step_V: Optional[float] = None,
 ) -> VirtualSourceModel:
     src_config = VirtualSourceConfig(name=name, V_intermediate_init_mV=2000)
     cal_emu = CalibrationEmulator()
@@ -35,6 +36,7 @@ def src_model(
         log_intermediate=False,
         dtype_in=dtype_in,
         window_size=window_size,
+        voltage_step_V=voltage_step_V,
     )
 
 
@@ -145,9 +147,12 @@ def test_vsource_vsrc_create_files(
 @pytest.mark.parametrize("src_name", src_list)
 def test_vsource_vsrc_sim_curve(src_name: str, file_ivcurve: Path) -> None:
     with Reader(file_ivcurve) as file:
-        window_size = file.get_window_samples()
-        dtype = file.get_datatype()
-        src = src_model("BQ25504s", dtype_in=dtype, window_size=window_size)
+        src = src_model(
+            "BQ25504s",
+            dtype_in=file.get_datatype(),
+            window_size=file.get_window_samples(),
+            voltage_step_V=file.get_voltage_step(),
+        )
         for _t, _v, _i in file.read_buffers():
             length = max(_v.size, _i.size)
             for _n in range(length):
@@ -157,9 +162,12 @@ def test_vsource_vsrc_sim_curve(src_name: str, file_ivcurve: Path) -> None:
 @pytest.mark.parametrize("src_name", src_list)
 def test_vsource_vsrc_sim_sample(src_name: str, file_ivsample: Path) -> None:
     with Reader(file_ivsample) as file:
-        window_size = file.get_window_samples()
-        dtype = file.get_datatype()
-        src = src_model("BQ25504s", dtype_in=dtype, window_size=window_size)
+        src = src_model(
+            "BQ25504s",
+            dtype_in=file.get_datatype(),
+            window_size=file.get_window_samples(),
+            voltage_step_V=file.get_voltage_step(),
+        )
         for _t, _v, _i in file.read_buffers():
             length = max(_v.size, _i.size)
             for _n in range(length):

{shepherd_core-2024.11.2 → shepherd_core-2025.2.1}/tests/vsource/test_harvester.py

@@ -39,7 +39,13 @@ def test_vsource_hrv_fail_ivcurve(hrv_name: str) -> None:
     # the first algos are not usable for ivcurve
     hrv_config = VirtualHarvesterConfig(name=hrv_name)
     with pytest.raises(ValueError):  # noqa: PT011
-        _ = HarvesterPRUConfig.from_vhrv(hrv_config, for_emu=True, dtype_in=EnergyDType.ivcurve)
+        _ = HarvesterPRUConfig.from_vhrv(
+            hrv_config,
+            for_emu=True,
+            dtype_in=EnergyDType.ivcurve,
+            window_size=100,
+            voltage_step_V=0.1,
+        )
 
 
 @pytest.mark.parametrize("hrv_name", hrv_list[3:])
@@ -51,6 +57,7 @@ def test_vsource_hrv_sim(hrv_name: str, file_ivcurve: Path) -> None:
             for_emu=True,
             dtype_in=file.get_datatype(),
             window_size=file.get_window_samples(),
+            voltage_step_V=file.get_voltage_step(),
         )
         hrv = VirtualHarvesterModel(hrv_pru)
         for _t, _v, _i in file.read_buffers():
@@ -71,3 +78,26 @@ def test_vsource_hrv_fail_unknown_type() -> None:
     hrv_config = VirtualHarvesterConfig(name="mppt_voc")
     with pytest.raises(KeyError):
         _ = HarvesterPRUConfig.from_vhrv(hrv_config, for_emu=True, dtype_in="xyz")
+
+
+def test_vsource_hrv_adapt_voltage_step() -> None:
+    hrv_config = VirtualHarvesterConfig(name="mppt_bq")
+    # first case without setting step-size
+    pru_config1 = HarvesterPRUConfig.from_vhrv(
+        hrv_config,
+        for_emu=True,
+        dtype_in=EnergyDType.ivcurve,
+        window_size=1000,
+        voltage_step_V=1e-3 * hrv_config.voltage_step_mV,
+    )
+    step_expected_uV = (pru_config1.voltage_max_uV - pru_config1.voltage_min_uV) / (1000 - 1)
+    assert pru_config1.voltage_step_uV > 2 * step_expected_uV
+    # now it gets set
+    pru_config2 = HarvesterPRUConfig.from_vhrv(
+        hrv_config,
+        for_emu=True,
+        dtype_in=EnergyDType.ivcurve,
+        window_size=1000,
+        voltage_step_V=1e-6 * step_expected_uV,
+    )
+    assert pru_config2.voltage_step_uV < 2 * step_expected_uV