shepherd-core 2025.4.1__tar.gz → 2025.5.2__tar.gz

{shepherd_core-2025.4.1 → shepherd_core-2025.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shepherd_core
-Version: 2025.4.1
+Version: 2025.5.2
 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>
@@ -18,7 +18,6 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Information Technology
 Classifier: Intended Audience :: Science/Research
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -27,7 +26,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Natural Language :: English
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: h5py
 Requires-Dist: numpy

{shepherd_core-2025.4.1 → shepherd_core-2025.5.2}/examples/experiment_generic_var1.py

@@ -15,13 +15,8 @@ What the code does:
 
 from pathlib import Path
 
+import shepherd_core.data_models as sm
 from shepherd_core import WebClient
-from shepherd_core.data_models import FirmwareDType
-from shepherd_core.data_models import GpioTracing
-from shepherd_core.data_models.content import EnergyEnvironment
-from shepherd_core.data_models.content import Firmware
-from shepherd_core.data_models.experiment import Experiment
-from shepherd_core.data_models.experiment import TargetConfig
 from shepherd_core.data_models.task import TestbedTasks
 from shepherd_core.data_models.testbed import MCU
 
@@ -34,28 +29,26 @@ do_connect = False
 if do_connect:
     WebClient()
 
-xp = Experiment(
+xp = sm.Experiment(
     id="4567",
     name="meaningful_TestName",
     # time_start could be "2033-03-13 14:15:16" or "datetime.now() + timedelta(minutes=30)"
     duration=30,
     target_configs=[
-        TargetConfig(
+        sm.TargetConfig(
             target_IDs=range(7, 12),
             custom_IDs=range(1, 100),  # note: longer list is OK
-            energy_env=EnergyEnvironment(name="eenv_static_3000mV_50mA_3600s"),
-            firmware1=Firmware(
+            energy_env=sm.EnergyEnvironment(name="eenv_static_3000mV_50mA_3600s"),
+            firmware1=sm.Firmware(
                 name="FW_TestXYZ",
                 data=Path("/var/shepherd/content/fw/nes_lab/nrf52_demo_rf/build.elf"),
-                data_type=FirmwareDType.path_elf,
+                data_type=sm.FirmwareDType.path_elf,
                 data_local=False,
                 mcu=MCU(name="nRF52"),
             ),
             power_tracing=None,
-            gpio_tracing=GpioTracing(
-                uart_decode=True,  # enables logging uart from userspace
-                uart_baudrate=115_200,
-            ),
+            gpio_tracing=sm.GpioTracing(),
+            uart_tracing=sm.UartTracing(baudrate=115_200),
         ),
     ],
 )

{shepherd_core-2025.4.1 → shepherd_core-2025.5.2}/examples/experiment_generic_var2.py

@@ -14,12 +14,8 @@
 
 from pathlib import Path
 
+import shepherd_core.data_models as sm
 from shepherd_core import WebClient
-from shepherd_core.data_models import GpioTracing
-from shepherd_core.data_models.content import EnergyEnvironment
-from shepherd_core.data_models.content import Firmware
-from shepherd_core.data_models.experiment import Experiment
-from shepherd_core.data_models.experiment import TargetConfig
 from shepherd_core.data_models.task import TestbedTasks
 
 # For online-queries the lib can be connected to the testbed-server.
@@ -31,24 +27,21 @@ do_connect = False
 if do_connect:
     WebClient()
 
-xp = Experiment(
+xp = sm.Experiment(
     id="4567",
     name="meaningful_TestName",
     # time_start could be "2033-03-13 14:15:16" or "datetime.now() + timedelta(minutes=30)"
     duration=30,
     target_configs=[
-        TargetConfig(
+        sm.TargetConfig(
             target_IDs=range(7, 12),
             custom_IDs=range(1, 100),  # note: longer list is OK
-            energy_env=EnergyEnvironment(name="eenv_static_3000mV_50mA_3600s"),
-            firmware1=Firmware.from_firmware(
+            energy_env=sm.EnergyEnvironment(name="eenv_static_3000mV_50mA_3600s"),
+            firmware1=sm.Firmware.from_firmware(
                 file=Path("./firmware_nrf.elf").absolute(),
             ),
             power_tracing=None,
-            gpio_tracing=GpioTracing(
-                uart_decode=True,  # enables logging uart from userspace
-                uart_baudrate=115_200,
-            ),
+            gpio_tracing=sm.GpioTracing(),
         ),
     ],
 )

{shepherd_core-2025.4.1 → shepherd_core-2025.5.2}/examples/experiment_models.py

@@ -18,17 +18,12 @@ How to define an experiment:
 
 """
 
+import shepherd_core.data_models as sm
 from shepherd_core import WebClient
-from shepherd_core.data_models.content import EnergyEnvironment
-from shepherd_core.data_models.content import Firmware
-from shepherd_core.data_models.content import VirtualHarvesterConfig
-from shepherd_core.data_models.content import VirtualSourceConfig
-from shepherd_core.data_models.experiment import Experiment
-from shepherd_core.data_models.experiment import TargetConfig
 from shepherd_core.data_models.task import TestbedTasks
 
 # generate description for all parameters -> base for web-forms
-Experiment.schema_to_file("experiment_schema.yaml")
+sm.Experiment.schema_to_file("experiment_schema.yaml")
 
 # For online-queries the lib can be connected to the testbed-server.
 # NOTE: there are 3 states:
@@ -40,11 +35,11 @@ if do_connect:
     WebClient()
 
 # Defining an Experiment in Python
-hrv = VirtualHarvesterConfig(name="mppt_bq_thermoelectric")
+hrv = sm.VirtualHarvesterConfig(name="mppt_bq_thermoelectric")
 
 target_cfgs = [
     # first Instance similar to yaml-syntax
-    TargetConfig(
+    sm.TargetConfig(
         target_IDs=[9, 10, 11],
         custom_IDs=[0, 1, 2],
         energy_env={"name": "SolarSunny"},
@@ -52,17 +47,17 @@ target_cfgs = [
         firmware1={"name": "nrf52_demo_rf"},
     ),
     # second Instance fully object-oriented (recommended)
-    TargetConfig(
+    sm.TargetConfig(
         target_IDs=list(range(1, 5)),
         custom_IDs=list(range(7, 18)),  # note: longer list is OK
-        energy_env=EnergyEnvironment(name="ThermoelectricWashingMachine"),
-        virtual_source=VirtualSourceConfig(name="BQ25570-Schmitt", harvester=hrv),
-        firmware1=Firmware(name="nrf52_demo_rf"),
-        firmware2=Firmware(name="msp430_deep_sleep"),
+        energy_env=sm.EnergyEnvironment(name="ThermoelectricWashingMachine"),
+        virtual_source=sm.VirtualSourceConfig(name="BQ25570-Schmitt", harvester=hrv),
+        firmware1=sm.Firmware(name="nrf52_demo_rf"),
+        firmware2=sm.Firmware(name="msp430_deep_sleep"),
     ),
 ]
 
-xperi1 = Experiment(
+xperi1 = sm.Experiment(
     id="4567",
     name="meaningful Test-Name",
     time_start="2033-03-13 14:15:16",  # or: datetime.now() + timedelta(minutes=30)
@@ -71,12 +66,12 @@ xperi1 = Experiment(
 
 # Safe, reload and compare content
 xperi1.to_file("experiment_from_py.yaml", minimal=False)
-xperi2 = Experiment.from_file("experiment_from_py.yaml")
+xperi2 = sm.Experiment.from_file("experiment_from_py.yaml")
 print(f"xp1 hash: {xperi1.get_hash()}")
 print(f"xp2 hash: {xperi2.get_hash()}")
 
 # comparison to same config (in yaml) fails due to internal variables, BUT:
-xperi3 = Experiment.from_file("experiment_from_yaml.yaml")
+xperi3 = sm.Experiment.from_file("experiment_from_yaml.yaml")
 print(f"xp3 hash: {xperi3.get_hash()} (won't match)")
 
 # Create a tasks-list for the testbed

shepherd_core-2025.5.2/examples/inventory.py

@@ -0,0 +1,20 @@
+"""Shows how to use inventory functionality."""
+
+from pathlib import Path
+
+import shepherd_core.inventory as si
+
+pyt_inv = si.PythonInventory.collect()
+print(f"PyInv: {pyt_inv}")
+sys_inv = si.SystemInventory.collect()
+print(f"SysInv: {sys_inv}")
+tgt_inv = si.TargetInventory.collect()
+print(f"TgtInv: {tgt_inv}")
+
+
+inv = si.Inventory.collect()
+print(f"Complete Inventory: {inv}")
+inv.to_file("inventory.yaml", minimal=True, comment="just a test")
+
+inl = si.InventoryList(elements=[inv])
+inl.to_csv(Path(__file__).parent / "inventory.csv")

{shepherd_core-2025.4.1 → shepherd_core-2025.5.2}/examples/simulate_vharvester.py

@@ -1,6 +1,6 @@
 """Demonstrate behavior of Virtual Harvester Algorithms.
 
-- simulation is based on ivsamples derived from a solar-isc-voc-recording during a jogging-trip
+- simulation is based on IVTrace derived from a solar-isc-voc-recording during a jogging-trip
 - harvesting is done by various algorithms and preconfigured virtual harvesters
 - results are printed on console (harvested energy)
 
@@ -44,13 +44,13 @@ save_files: bool = False
 # convert IVonne to IVCurve
 if not file_ivcurve.exists():
     with ivonne.Reader(file_ivonne) as db:
-        db.convert_2_ivcurves(file_ivcurve, duration_s=sim_duration)
+        db.convert_2_ivsurface(file_ivcurve, duration_s=sim_duration)
 
 # Input Statistics
 with Reader(file_ivcurve, verbose=False) as file:
     window_size = file.get_window_samples()
     I_in_max = 0.0
-    for _t, _v, _i in file.read_buffers():
+    for _t, _v, _i in file.read():
         I_in_max = max(I_in_max, _i.max())
     print(
         f"Input-file: \n"
@@ -61,11 +61,7 @@ with Reader(file_ivcurve, verbose=False) as file:
 
 # Simulation
 for hrv_name in hrv_list:
-    file_output = (
-        file_ivcurve.with_name(file_ivcurve.stem + "_" + hrv_name + file_ivcurve.suffix)
-        if save_files
-        else None
-    )
+    file_output = file_ivcurve.with_stem(file_ivcurve.stem + "_" + hrv_name) if save_files else None
     E_out_Ws = simulate_harvester(
         config=VirtualHarvesterConfig(name=hrv_name),
         path_input=file_ivcurve,

{shepherd_core-2025.4.1 → shepherd_core-2025.5.2}/examples/simulate_vsource.py

@@ -42,11 +42,7 @@ tgt = ResistiveTarget(R_Ohm=1_000, controlled=True)
 save_files = True
 
 for src_name in src_list:
-    file_output = (
-        file_input.with_name(file_input.stem + "_emu_" + src_name + file_input.suffix)
-        if save_files
-        else None
-    )
+    file_output = file_input.with_stem(file_input.stem + "_emu_" + src_name) if save_files else None
 
     e_out_Ws = simulate_source(
         config=VirtualSourceConfig(

{shepherd_core-2025.4.1 → shepherd_core-2025.5.2}/pyproject.toml

@@ -14,7 +14,6 @@ classifiers = [
     "Intended Audience :: Developers",
     "Intended Audience :: Information Technology",
     "Intended Audience :: Science/Research",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
@@ -25,7 +24,7 @@ classifiers = [
     "Natural Language :: English",
 ]
 
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 dependencies = [
     "h5py",
     "numpy",
@@ -111,6 +110,10 @@ source = ["shepherd_core"]
 omit = ["*/shepherd_data/*"]
 
 [tool.mypy]
-python_version = 3.8
+python_version = 3.9
 ignore_missing_imports = true
 disable_error_code = ["call-arg", ]
+exclude = [
+    "build/",
+    ".egg-info/",
+]

{shepherd_core-2025.4.1 → shepherd_core-2025.5.2}/shepherd_core/calibration_hw_def.py

@@ -10,26 +10,26 @@ currently configured for cape v2.4c
 """
 
 # both current channels have a 0.1 % shunt resistance of
-R_SHT = 2.0  # [ohm]
+R_SHT: float = 2.0  # [ohm]
 # the instrumentation amplifiers are configured for gain of
-G_INST_AMP = 48  # [n]
+G_INST_AMP: int = 48  # [n]
 # we use the ADC's internal reference with
-V_REF_ADC = 4.096  # [V]
+V_REF_ADC: float = 4.096  # [V]
 # range of current channels is
-G_ADC_I = 1.25  # [gain / V_REF]
+G_ADC_I: float = 1.25  # [gain / V_REF]
 # range of voltage channels is
-G_ADC_V = 1.25  # [gain / V_REF]
+G_ADC_V: float = 1.25  # [gain / V_REF]
 # bit resolution of ADC
-M_ADC = 18  # [bit]
+M_ADC: int = 18  # [bit]
 # DACs use internal reference with
-V_REF_DAC = 2.5  # [V]
+V_REF_DAC: float = 2.5  # [V]
 # gain of DAC is set to
-G_DAC = 2  # [n]
+G_DAC: int = 2  # [n]
 # bit resolution of DAC
-M_DAC = 16  # [bit]
+M_DAC: int = 16  # [bit]
 # DERIVED VARIABLES
-RAW_MAX_ADC = 2**M_ADC - 1
-RAW_MAX_DAC = 2**M_DAC - 1
+RAW_MAX_ADC: int = 2**M_ADC - 1
+RAW_MAX_DAC: int = 2**M_DAC - 1
 
 
 def adc_current_to_raw(current: float, *, limited: bool = True) -> int:

shepherd_core-2025.5.2/shepherd_core/commons.py

@@ -0,0 +1,8 @@
+"""Container for commonly shared constants."""
+
+SAMPLERATE_SPS_DEFAULT: int = 100_000
+
+UID_NAME: str = "SHEPHERD_NODE_ID"
+UID_SIZE: int = 2
+
+TESTBED_SERVER_URI: str = "http://127.0.0.1:8000/shepherd"

{shepherd_core-2025.4.1 → shepherd_core-2025.5.2}/shepherd_core/data_models/__init__.py

@@ -31,6 +31,7 @@ from .experiment.observer_features import GpioLevel
 from .experiment.observer_features import GpioTracing
 from .experiment.observer_features import PowerTracing
 from .experiment.observer_features import SystemLogging
+from .experiment.observer_features import UartTracing
 from .experiment.target_config import TargetConfig
 
 __all__ = [
@@ -54,6 +55,7 @@ __all__ = [
     "ShpModel",
     "SystemLogging",
     "TargetConfig",
+    "UartTracing",
     "VirtualHarvesterConfig",
     "VirtualSourceConfig",
     "Wrapper",

{shepherd_core-2025.4.1 → shepherd_core-2025.5.2}/shepherd_core/data_models/base/cal_measurement.py

@@ -1,13 +1,12 @@
 """Models for the process of calibration a device by measurements."""
 
-from typing import List
+from typing import Annotated
 from typing import Optional
 
 import numpy as np
 from pydantic import Field
 from pydantic import PositiveFloat
 from pydantic import validate_call
-from typing_extensions import Annotated
 
 from .calibration import CalibrationCape
 from .calibration import CalibrationEmulator
@@ -24,7 +23,7 @@ class CalMeasurementPair(ShpModel):
     reference_si: float = 0
 
 
-CalMeasPairs = Annotated[List[CalMeasurementPair], Field(min_length=2)]
+CalMeasPairs = Annotated[list[CalMeasurementPair], Field(min_length=2)]
 
 
 @validate_call
@@ -37,16 +36,16 @@ def meas_to_cal(data: CalMeasPairs, component: str) -> CalibrationPair:
         y[i] = pair.reference_si
 
     model = np.polyfit(x, y, 1)
-    offset = model[1]
-    gain = model[0]
+    offset: float = float(model[1])
+    gain: float = float(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
+    _p = np.poly1d(model)
+    yhat = _p(x)
+    ybar: float = np.sum(y) / len(y)
+    ssreg: float = np.sum((yhat - ybar) ** 2)
+    sstot: float = np.sum((y - ybar) ** 2)
+    rval: float = ssreg / sstot
 
     if rval < 0.999:
         msg = (

{shepherd_core-2025.4.1 → shepherd_core-2025.5.2}/shepherd_core/data_models/base/calibration.py

@@ -1,11 +1,11 @@
 """Models for the calibration-data to convert between raw & SI-Values."""
 
 import struct
+from collections.abc import Generator
+from collections.abc import Mapping
+from collections.abc import Sequence
 from typing import Callable
-from typing import Generator
-from typing import Mapping
 from typing import Optional
-from typing import Sequence
 from typing import TypeVar
 from typing import Union
 
@@ -18,9 +18,10 @@ from pydantic import constr
 from pydantic import validate_call
 from typing_extensions import Self
 
-from ...calibration_hw_def import adc_current_to_raw
-from ...calibration_hw_def import adc_voltage_to_raw
-from ...calibration_hw_def import dac_voltage_to_raw
+from shepherd_core.calibration_hw_def import adc_current_to_raw
+from shepherd_core.calibration_hw_def import adc_voltage_to_raw
+from shepherd_core.calibration_hw_def import dac_voltage_to_raw
+
 from .shepherd import ShpModel
 from .timezone import local_iso_date
 

{shepherd_core-2025.4.1 → shepherd_core-2025.5.2}/shepherd_core/data_models/base/content.py

@@ -2,6 +2,7 @@
 
 import hashlib
 from datetime import datetime
+from typing import Annotated
 from typing import Optional
 from typing import Union
 from uuid import uuid4
@@ -10,7 +11,6 @@ from pydantic import UUID4
 from pydantic import Field
 from pydantic import StringConstraints
 from pydantic import model_validator
-from typing_extensions import Annotated
 from typing_extensions import Self
 from typing_extensions import deprecated
 

{shepherd_core-2025.4.1 → shepherd_core-2025.5.2}/shepherd_core/data_models/base/shepherd.py

@@ -2,11 +2,11 @@
 
 import hashlib
 import pathlib
+from collections.abc import Generator
 from datetime import timedelta
 from ipaddress import IPv4Address
 from pathlib import Path
 from typing import Any
-from typing import Generator
 from typing import Optional
 from typing import Union
 from uuid import UUID
@@ -15,27 +15,26 @@ import yaml
 from pydantic import BaseModel
 from pydantic import ConfigDict
 from typing_extensions import Self
-from yaml import Dumper
+from yaml import Node
 from yaml import SafeDumper
-from yaml import ScalarNode
 
 from .timezone import local_now
 from .wrapper import Wrapper
 
 
 def path2str(
-    dumper: Dumper, data: Union[pathlib.Path, pathlib.WindowsPath, pathlib.PosixPath]
-) -> ScalarNode:
+    dumper: SafeDumper, data: Union[pathlib.Path, pathlib.WindowsPath, pathlib.PosixPath]
+) -> Node:
     """Add a yaml-representation for a specific datatype."""
     return dumper.represent_scalar("tag:yaml.org,2002:str", str(data.as_posix()))
 
 
-def time2int(dumper: Dumper, data: timedelta) -> ScalarNode:
+def time2int(dumper: SafeDumper, data: timedelta) -> Node:
     """Add a yaml-representation for a specific datatype."""
     return dumper.represent_scalar("tag:yaml.org,2002:int", str(int(data.total_seconds())))
 
 
-def generic2str(dumper: Dumper, data: Any) -> ScalarNode:
+def generic2str(dumper: SafeDumper, data: Any) -> Node:
     """Add a yaml-representation for a specific datatype."""
     return dumper.represent_scalar("tag:yaml.org,2002:str", str(data))
 

{shepherd_core-2025.4.1 → shepherd_core-2025.5.2}/shepherd_core/data_models/base/wrapper.py

@@ -1,13 +1,13 @@
 """Wrapper-related ecosystem for transferring models."""
 
 from datetime import datetime
+from typing import Annotated
 from typing import Optional
 
 from pydantic import BaseModel
 from pydantic import StringConstraints
-from typing_extensions import Annotated
 
-from ...version import version
+from shepherd_core.version import version
 
 SafeStrClone = Annotated[str, StringConstraints(pattern=r"^[ -~]+$")]
 # ⤷ copy avoids circular import