shepherd-core 2024.7.3__py3-none-any.whl → 2024.7.4__py3-none-any.whl

shepherd_core/calibration_hw_def.py

@@ -32,45 +32,48 @@ RAW_MAX_ADC = 2**M_ADC - 1
 RAW_MAX_DAC = 2**M_DAC - 1
 
 
-def adc_current_to_raw(current: float) -> int:
+def adc_current_to_raw(current: float, *, limited: bool = True) -> int:
     """Convert back a current [A] to raw ADC value."""
     # voltage on input of adc
     val_adc = G_INST_AMP * R_SHT * current
     # digital value according to ADC gain
     val_raw = int(val_adc * (2**M_ADC) / (G_ADC_I * V_REF_ADC))
-    return min(max(val_raw, 0), 2**M_ADC - 1)
+    return min(max(val_raw, 0), 2**M_ADC - 1) if limited else val_raw
 
 
-def adc_raw_to_current(value: int) -> float:
+def adc_raw_to_current(value: int, *, limited: bool = True) -> float:
     """Convert a raw ADC value to a current [A]."""
-    value = min(max(value, 0), 2**M_ADC - 1)
+    if limited:
+        value = min(max(value, 0), 2**M_ADC - 1)
     # voltage on input of adc
     val_adc = float(value) * (G_ADC_I * V_REF_ADC) / (2**M_ADC)
     # current according to adc value
     return val_adc / (R_SHT * G_INST_AMP)
 
 
-def adc_voltage_to_raw(voltage: float) -> int:
+def adc_voltage_to_raw(voltage: float, *, limited: bool = True) -> int:
     """Convert back a voltage [V] to raw ADC value."""
     # digital value according to ADC gain
     val_raw = int(voltage * (2**M_ADC) / (G_ADC_V * V_REF_ADC))
-    return min(max(val_raw, 0), 2**M_ADC - 1)
+    return min(max(val_raw, 0), 2**M_ADC - 1) if limited else val_raw
 
 
-def adc_raw_to_voltage(value: int) -> float:
+def adc_raw_to_voltage(value: int, *, limited: bool = True) -> float:
     """Convert a raw ADC value to a voltage [V]."""
-    value = min(max(value, 0), 2**M_ADC - 1)
+    if limited:
+        value = min(max(value, 0), 2**M_ADC - 1)
     # voltage according to ADC value
     return float(value) * (G_ADC_V * V_REF_ADC) / (2**M_ADC)
 
 
-def dac_raw_to_voltage(value: int) -> float:
+def dac_raw_to_voltage(value: int, *, limited: bool = True) -> float:
     """Convert back a raw DAC value to a voltage [V]."""
-    value = min(max(value, 0), 2**M_DAC - 1)
+    if limited:
+        value = min(max(value, 0), 2**M_DAC - 1)
     return float(value) * (V_REF_DAC * G_DAC) / (2**M_DAC)
 
 
-def dac_voltage_to_raw(voltage: float) -> int:
+def dac_voltage_to_raw(voltage: float, *, limited: bool = True) -> int:
     """Convert a voltage [V] to raw DAC value."""
     val_raw = int(voltage * (2**M_DAC) / (V_REF_DAC * G_DAC))
-    return min(max(val_raw, 0), 2**M_DAC - 1)
+    return min(max(val_raw, 0), 2**M_DAC - 1) if limited else val_raw

shepherd_core/data_models/base/calibration.py

@@ -51,6 +51,7 @@ class CalibrationPair(ShpModel):
 
     gain: PositiveFloat
     offset: float = 0
+    # TODO: add unit
 
     def raw_to_si(self, values_raw: Calc_t, *, allow_negative: bool = True) -> Calc_t:
         """Convert between physical units and raw unsigned integers."""
@@ -79,8 +80,8 @@ class CalibrationPair(ShpModel):
     @classmethod
     def from_fn(cls, fn: Callable) -> Self:
         """Probe linear function to determine scaling values."""
-        offset = fn(0)
-        gain_inv = fn(1.0) - offset
+        offset = fn(0, limited=False)
+        gain_inv = fn(1.0, limited=False) - offset
         return cls(
             gain=1.0 / float(gain_inv),
             offset=-float(offset) / gain_inv,
@@ -274,7 +275,7 @@ class CalibrationSeries(ShpModel):
         emu_port_a: bool = True,
     ) -> Self:
         if isinstance(cal, CalibrationHarvester):
-            return cls(voltage=cal.adc_V_Sense, current=cal.dac_V_Hrv)
+            return cls(voltage=cal.adc_V_Sense, current=cal.adc_C_Hrv)
         if emu_port_a:
             return cls(voltage=cal.dac_V_A, current=cal.adc_C_A)
         return cls(voltage=cal.dac_V_B, current=cal.adc_C_B)

shepherd_core/version.py

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

{shepherd_core-2024.7.3.dist-info → shepherd_core-2024.7.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shepherd_core
-Version: 2024.7.3
+Version: 2024.7.4
 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>
@@ -136,28 +136,30 @@ Notes:
 The Library is available via PyPI and can be installed with
 
 ```shell
-  pip install shepherd-core -U
+pip install shepherd-core -U
 
-  # or for the full experience (includes core)
-  pip install shepherd-data -U
+# or for the full experience (includes core)
+pip install shepherd-data -U
 ```
 
 For bleeding-edge-features or dev-work it is possible to install directly from GitHub-Sources (here `dev`-branch):
 
 ```Shell
 pip install git+https://github.com/orgua/shepherd-datalib.git@dev#subdirectory=shepherd_core -U
+# and on sheep with newer debian
+pip install git+https://github.com/orgua/shepherd-datalib.git@dev#subdirectory=shepherd_core -U --break-system-packages
 ```
 
 If you are working with ``.elf``-files (embedding into experiments) you make "objcopy" accessible to python. In Ubuntu, you can either install ``build-essential`` or ``binutils-$ARCH`` with arch being ``msp430`` or ``arm-none-eabi`` for the nRF52.
 
 ```shell
-  sudo apt install build-essential
+sudo apt install build-essential
 ```
 
 For more advanced work with ``.elf``-files (modify value of symbols / target-ID) you should install
 
 ```shell
-  pip install shepherd-core[elf]
+pip install shepherd-core[elf]
 ```
 
 and also make sure the prereqs for the [pwntools](https://docs.pwntools.com/en/stable/install.html) are met.
@@ -165,7 +167,7 @@ and also make sure the prereqs for the [pwntools](https://docs.pwntools.com/en/s
 For creating an inventory of the host-system you should install
 
 ```shell
-  pip install shepherd-core[inventory]
+pip install shepherd-core[inventory]
 ```
 
 ## Unittests

{shepherd_core-2024.7.3.dist-info → shepherd_core-2024.7.4.dist-info}/RECORD

@@ -1,16 +1,16 @@
 shepherd_core/__init__.py,sha256=QyqENyf508XfZQ4vDU5o6UL9rmIqkf8kzwgTF9XU1-Y,1270
-shepherd_core/calibration_hw_def.py,sha256=m5HDxHJ_blnn-C0Og5v6by1ApJRDT7RhytFbL-P5730,2548
+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=9BuArqou5pmPKUrJH9oiPYlU1DkMxUScL4nftDJuFIs,26790
-shepherd_core/version.py,sha256=_g69sZNO8AhbkOwQt8KmcgsSbdI6Yyb6XSYvZKHehC0,75
+shepherd_core/version.py,sha256=nuk8f6h1RBadV7-koFp4yLk1jExaUHnFqMTtxlKZyCo,75
 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=YScPG7QLynbUHdjcznYqU8O5KRh0XiROGxGSk9BETMk,3357
-shepherd_core/data_models/base/calibration.py,sha256=HPhDEaApOCKxfX2q9RD8YCvA3Gqls-2bHqvLLvOM7kY,10415
+shepherd_core/data_models/base/calibration.py,sha256=iy04ajChReqrRNLoNDEH01CM-iCvb5XepBIlyFSWeII,10466
 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
@@ -70,8 +70,8 @@ shepherd_core/vsource/__init__.py,sha256=dS33KYLq5GQ9_D8HfdP8iWSocWTghCi2ZZG2AJW
 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.7.3.dist-info/METADATA,sha256=dbgRhKRkV3GkLlSKX6qbbIFloUtGQuPdM-Sjmx-Vt2Y,7630
-shepherd_core-2024.7.3.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
-shepherd_core-2024.7.3.dist-info/top_level.txt,sha256=wy-t7HRBrKARZxa-Y8_j8d49oVHnulh-95K9ikxVhew,14
-shepherd_core-2024.7.3.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-shepherd_core-2024.7.3.dist-info/RECORD,,
+shepherd_core-2024.7.4.dist-info/METADATA,sha256=zFRCTLQEf-XN8Szx8fxb2JwCA6H0F26oUU5UMgWxVaA,7771
+shepherd_core-2024.7.4.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+shepherd_core-2024.7.4.dist-info/top_level.txt,sha256=wy-t7HRBrKARZxa-Y8_j8d49oVHnulh-95K9ikxVhew,14
+shepherd_core-2024.7.4.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+shepherd_core-2024.7.4.dist-info/RECORD,,

{shepherd_core-2024.7.3.dist-info → shepherd_core-2024.7.4.dist-info}/WHEEL

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