shepherd-core 2024.11.2__py3-none-any.whl → 2024.11.3__py3-none-any.whl

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/reader.py

@@ -270,6 +270,26 @@ 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]
+            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 +298,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/version.py

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

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/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/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.dist-info → shepherd_core-2024.11.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shepherd_core
-Version: 2024.11.2
+Version: 2024.11.3
 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.dist-info → shepherd_core-2024.11.3.dist-info}/RECORD

@@ -2,8 +2,8 @@ shepherd_core/__init__.py,sha256=fCld2mcl0y0h6kRyPal3DP-sWXnKl_0aYWYBdg4QuUk,127
 shepherd_core/calibration_hw_def.py,sha256=_nMzgNzSnYyqcLnVCGd4tfA2e0avUXbccjmNpFhiDgo,2830
 shepherd_core/commons.py,sha256=vymKXWcy_1bz7ChzzEATUkJ4p3czCzjIdsSehVjJOY8,218
 shepherd_core/logger.py,sha256=4Q4hTI-nccOZ1_A68fo4UEctfu3pJx3IeHfa9VuDDEo,1804
-shepherd_core/reader.py,sha256=Sg7s5UfV01CejI3_nolG7qrSDUBenmt1WPo2BPJee8o,27058
-shepherd_core/version.py,sha256=VcNt0axHoC1XdR-xRoXqeXfpY9UK9aTjZK9-wOWmzlc,76
+shepherd_core/reader.py,sha256=OBjvvo-R_68RPAlgTWfYkNeIW-wEeHVcSzScxLhYhvg,28021
+shepherd_core/version.py,sha256=efgburSXJlcrRhiL0_hKDFmBgNSmAdHw7BRzTIN918M,76
 shepherd_core/writer.py,sha256=GMR-7vkOgpTNPoknBWsRsC7-b7iGMtT60-KtSKunNe8,14636
 shepherd_core/data_models/__init__.py,sha256=bnHSP_HBOYm4WuoiHs_vyiRsWlvkyDjsarMNfKedN-Q,1836
 shepherd_core/data_models/readme.md,sha256=1bdfEypY_0NMhXLxOPRnLAsFca0HuHdq7_01yEWxvUs,2470
@@ -21,7 +21,7 @@ shepherd_core/data_models/content/energy_environment.py,sha256=WuXMkKqnibGzM2WeW
 shepherd_core/data_models/content/energy_environment_fixture.yaml,sha256=UBXTdGT7MK98zx5w_RBCu-f9uNCKxRgiFBQFbmDUxPc,1301
 shepherd_core/data_models/content/firmware.py,sha256=MyEiaP6bkOm7i_oihDXTxHC7ajc5aqiIDLn7mhap6YY,5722
 shepherd_core/data_models/content/firmware_datatype.py,sha256=XPU9LOoT3h5qFOlE8WU0vAkw-vymNxzor9kVFyEqsWg,255
-shepherd_core/data_models/content/virtual_harvester.py,sha256=MXmSJ_nRp1mSzxfTNk60o9h5Yrp2lFMbLphUVSnNeNc,9999
+shepherd_core/data_models/content/virtual_harvester.py,sha256=cf-DrSacZsct9e8eGoR4PX7S7RXlbxQfJHVsLR9njlM,10749
 shepherd_core/data_models/content/virtual_harvester_fixture.yaml,sha256=LZe5ue1xYhXZwB3a32sva-L4uKhkQA5AtG9JzW4B2hQ,4564
 shepherd_core/data_models/content/virtual_source.py,sha256=PPAphxEXvgMM7OVZ2dBkYAvJQkmj5Kb2BYFogVUs7B8,15354
 shepherd_core/data_models/content/virtual_source_fixture.yaml,sha256=1o-31mGgn7eyCNidKoOUp9vZh3K4Al0kJgmz54Q2DAE,11191
@@ -71,11 +71,11 @@ shepherd_core/vsource/__init__.py,sha256=vTvFWuJn4eurPNzEiMd15c1Rd6o3DTWzCfbhOom
 shepherd_core/vsource/target_model.py,sha256=LaB5ppi2-IIpIepDqDvOliR-BupzccJl44yRxjlF-ms,5113
 shepherd_core/vsource/virtual_converter_model.py,sha256=3TyxphUMunoGhMda7AWCHZQU8pjRSvxB-9R8lfZFnok,11592
 shepherd_core/vsource/virtual_harvester_model.py,sha256=GyA0uGl3r42t5c4roYtEaj22b0-b5DAHUr2e9DuNn-c,9765
-shepherd_core/vsource/virtual_harvester_simulation.py,sha256=EiBrvmc6D2N7Z0DqFBWPdRJK6hR8Q3iQaj7EYP9pLA0,2405
-shepherd_core/vsource/virtual_source_model.py,sha256=-JSYUfsnYlNo5RfPBhx2G33fo5AjSeFSf2O6unroyFw,2945
-shepherd_core/vsource/virtual_source_simulation.py,sha256=k1v2zpNdJTqiO9uY8TXaq-IUKK6m5l-LEWebYva0skk,5088
-shepherd_core-2024.11.2.dist-info/METADATA,sha256=yeF95R5lUvrrwsbogULe4EUG01YQYexCCOfjPhPJ4vo,7807
-shepherd_core-2024.11.2.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-shepherd_core-2024.11.2.dist-info/top_level.txt,sha256=wy-t7HRBrKARZxa-Y8_j8d49oVHnulh-95K9ikxVhew,14
-shepherd_core-2024.11.2.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-shepherd_core-2024.11.2.dist-info/RECORD,,
+shepherd_core/vsource/virtual_harvester_simulation.py,sha256=MFT583s73BJZYyhcqgnDUGTPr9s_lN_lKafzJG6kueE,2457
+shepherd_core/vsource/virtual_source_model.py,sha256=9tiOzgrEgdEH5Uuhd8hjmmIkquNDuaNjLlblvInIlzg,3036
+shepherd_core/vsource/virtual_source_simulation.py,sha256=ZOnFd2uPawY2G1salCiLGx9o1OBG99_-EHBtDjx4ZUo,5140
+shepherd_core-2024.11.3.dist-info/METADATA,sha256=OBSLkOgbXMb_mhTym-Dk2p_GoPkGQyzMbYlaRhRhicU,7807
+shepherd_core-2024.11.3.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+shepherd_core-2024.11.3.dist-info/top_level.txt,sha256=wy-t7HRBrKARZxa-Y8_j8d49oVHnulh-95K9ikxVhew,14
+shepherd_core-2024.11.3.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+shepherd_core-2024.11.3.dist-info/RECORD,,