shepherd-data 2025.6.3__py3-none-any.whl → 2025.8.1__py3-none-any.whl

shepherd_data/__init__.py

@@ -11,7 +11,7 @@ from shepherd_core import Writer
 
 from .reader import Reader
 
-__version__ = "2025.06.3"
+__version__ = "2025.08.1"
 
 __all__ = [
     "Reader",

shepherd_data/cli.py

@@ -5,16 +5,13 @@ import sys
 from contextlib import suppress
 from datetime import datetime
 from pathlib import Path
-from typing import Optional
 
 import click
-import pydantic
 
 from shepherd_core import get_verbose_level
 from shepherd_core import local_tz
 from shepherd_core.logger import set_log_verbose_level
 
-from . import __version__
 from .reader import Reader
 
 logger = logging.getLogger("SHPData.cli")
@@ -58,17 +55,22 @@ def cli(ctx: click.Context, *, verbose: bool) -> None:
 @cli.command(short_help="Print version-info (combine with -v for more)")
 def version() -> None:
     """Print version-info (combine with -v for more)."""
-    logger.info("Shepherd-Data v%s", __version__)
+    from importlib import metadata  # noqa: PLC0415
+
     logger.debug("Python v%s", sys.version)
-    logger.debug("Click v%s", click.__version__)
-    logger.debug("Pydantic v%s", pydantic.__version__)
+    logger.info("Shepherd-Data v%s", metadata.version("shepherd_data"))
+    logger.debug("Shepherd-Core v%s", metadata.version("shepherd_core"))
+    logger.debug("h5py v%s", metadata.version("h5py"))
+    logger.debug("numpy v%s", metadata.version("numpy"))
+    logger.debug("Click v%s", metadata.version("click"))
+    logger.debug("Pydantic v%s", metadata.version("pydantic"))
 
 
 @cli.command(short_help="Validates a file or directory containing shepherd-recordings")
 @click.argument("in_data", type=click.Path(exists=True, resolve_path=True))
 @click.option(
     "--recurse",
-    "-a",
+    "-R",
     is_flag=True,
     help="Also consider files in sub-folders",
 )
@@ -129,14 +131,14 @@ def validate(in_data: Path, *, recurse: bool = False) -> None:
 )
 @click.option(
     "--recurse",
-    "-a",
+    "-R",
     is_flag=True,
     help="Also consider files in sub-folders",
 )
 def extract(
     in_data: Path,
-    start: Optional[float],
-    end: Optional[float],
+    start: float | None,
+    end: float | None,
     ds_factor: float,
     separator: str,
     *,
@@ -173,7 +175,7 @@ def extract(
 )
 @click.option(
     "--recurse",
-    "-a",
+    "-R",
     is_flag=True,
     help="Also consider files in sub-folders",
 )
@@ -211,7 +213,7 @@ def extract_meta(
                 if not debug:
                     continue
                 csv_depr = ["sysutil", "timesync"]
-                csv_meta = ["ptp", "phc2sys", "sys_util", "pru_util"]
+                csv_meta = ["ptp", "phc2sys", "sys_util", "pru_util", "power"]
                 for element in csv_meta + csv_depr:
                     if element in shpr.h5file:
                         shpr.save_csv(shpr[element], separator)
@@ -223,7 +225,7 @@ def extract_meta(
 @click.argument("in_data", type=click.Path(exists=True, resolve_path=True))
 @click.option(
     "--recurse",
-    "-a",
+    "-R",
     is_flag=True,
     help="Also consider files in sub-folders",
 )
@@ -248,7 +250,7 @@ def extract_uart(in_data: Path, *, recurse: bool = False) -> None:
 @click.argument("in_data", type=click.Path(exists=True, resolve_path=True))
 @click.option(
     "--recurse",
-    "-a",
+    "-R",
     is_flag=True,
     help="Also consider files in sub-folders",
 )
@@ -294,7 +296,7 @@ def decode_uart(in_data: Path, *, recurse: bool = False) -> None:
 )  # TODO: also configure decimal point
 @click.option(
     "--recurse",
-    "-a",
+    "-R",
     is_flag=True,
     help="Also consider files in sub-folders",
 )
@@ -347,16 +349,16 @@ def extract_gpio(in_data: Path, separator: str, *, recurse: bool = False) -> Non
 )
 @click.option(
     "--recurse",
-    "-a",
+    "-R",
     is_flag=True,
     help="Also consider files in sub-folders",
 )
 def downsample(
     in_data: Path,
-    ds_factor: Optional[float],
-    sample_rate: Optional[int],
-    start: Optional[float],
-    end: Optional[float],
+    ds_factor: float | None,
+    sample_rate: int | None,
+    start: float | None,
+    end: float | None,
     *,
     recurse: bool = False,
 ) -> None:
@@ -425,14 +427,15 @@ def downsample(
 )
 @click.option(
     "--recurse",
-    "-a",
+    "-R",
     is_flag=True,
     help="Also consider files in sub-folders",
 )
+# TODO: allow SVG-output
 def plot(
     in_data: Path,
-    start: Optional[float],
-    end: Optional[float],
+    start: float | None,
+    end: float | None,
     width: int,
     height: int,
     *,

shepherd_data/ivonne.py

@@ -16,7 +16,6 @@ import os
 import pickle
 from pathlib import Path
 from types import TracebackType
-from typing import Optional
 
 import numpy as np
 import pandas as pd
@@ -48,7 +47,7 @@ class Reader:
     def __init__(
         self,
         file_path: Path,
-        samplerate_sps: Optional[int] = None,
+        samplerate_sps: int | None = None,
         *,
         verbose: bool = True,
     ) -> None:
@@ -66,7 +65,7 @@ class Reader:
         self.file_size: int = 0
         self.data_rate: float = 0
 
-        self._df: Optional[pd.DataFrame] = None
+        self._df: pd.DataFrame | None = None
 
     def __enter__(self) -> Self:
         if not self.file_path.exists():
@@ -88,9 +87,9 @@ class Reader:
 
     def __exit__(
         self,
-        typ: Optional[type[BaseException]] = None,
-        exc: Optional[BaseException] = None,
-        tb: Optional[TracebackType] = None,
+        typ: type[BaseException] | None = None,
+        exc: BaseException | None = None,
+        tb: TracebackType | None = None,
         extra_arg: int = 0,
     ) -> None:
         pass
@@ -107,7 +106,7 @@ class Reader:
         shp_output: Path,
         v_max: float = 5.0,
         pts_per_curve: int = 1000,
-        duration_s: Optional[float] = None,
+        duration_s: float | None = None,
     ) -> None:
         """Transform recorded parameters to shepherd hdf database with IV curves.
 
@@ -170,8 +169,8 @@ class Reader:
         self,
         shp_output: Path,
         v_max: float = 5.0,
-        duration_s: Optional[float] = None,
-        tracker: Optional[MPPTracker] = None,
+        duration_s: float | None = None,
+        tracker: MPPTracker | None = None,
     ) -> None:
         """Transform shepherd IV surface / curves to shepherd IV trace / samples .
 
@@ -240,7 +239,7 @@ class Reader:
         self,
         shp_output: Path,
         v_max: float = 5.0,
-        duration_s: Optional[float] = None,
+        duration_s: float | None = None,
     ) -> None:
         """Transform ivonne-parameters to up-sampled versions for shepherd.
 

shepherd_data/reader.py

@@ -5,8 +5,6 @@ from collections.abc import Mapping
 from collections.abc import Sequence
 from datetime import datetime
 from pathlib import Path
-from typing import Optional
-from typing import Union
 
 import h5py
 import numpy as np
@@ -166,14 +164,14 @@ class Reader(CoreReader):
 
     def downsample(
         self,
-        data_src: Union[h5py.Dataset, np.ndarray],
-        data_dst: Union[None, h5py.Dataset, np.ndarray],
+        data_src: h5py.Dataset | np.ndarray,
+        data_dst: None | h5py.Dataset | np.ndarray,
         start_n: int = 0,
-        end_n: Optional[int] = None,
+        end_n: int | None = None,
         ds_factor: float = 5,
         *,
         is_time: bool = False,
-    ) -> Union[None, h5py.Dataset, np.ndarray]:
+    ) -> None | h5py.Dataset | np.ndarray:
         """Sample down iv-data.
 
         Warning: only valid for IV-Stream, not IV-Curves,
@@ -187,19 +185,23 @@ class Reader(CoreReader):
         :param is_time: time is not really down-sampled, but decimated
         :return: resampled h5-dataset or numpy-array
         """
-        from scipy import signal  # here due to massive delay
+        # import only when needed, due to massive delay
+        from scipy import signal  # noqa: PLC0415
 
         if self.get_datatype() == EnergyDType.ivsurface:
             self._logger.warning("Downsampling-Function was not written for IVSurfaces")
         ds_factor = max(1, math.floor(ds_factor))
-
-        if isinstance(end_n, (int, float)):
-            _end_n = min(data_src.shape[0], round(end_n))
+        if not isinstance(start_n, int):
+            raise TypeError("start_n must be an integer")
+        if isinstance(end_n, int):
+            end_n = min(data_src.shape[0], end_n)
+        elif isinstance(end_n, float):
+            raise TypeError("end_n must be an integer")
         else:
-            _end_n = data_src.shape[0]
+            end_n = data_src.shape[0]
 
-        start_n = min(_end_n, round(start_n))
-        data_len = _end_n - start_n  # TODO: one-off to calculation below ?
+        start_n = min(end_n, start_n)
+        data_len = end_n - start_n  # TODO: one-off to calculation below ?
         if data_len == 0:
             self._logger.warning("downsampling failed because of data_len = 0")
             return data_dst
@@ -258,8 +260,8 @@ class Reader(CoreReader):
 
     def cut_and_downsample_to_file(
         self,
-        start_s: Optional[float],
-        end_s: Optional[float],
+        start_s: float | None,
+        end_s: float | None,
         ds_factor: float,
     ) -> Path:
         """Cut source to given limits, downsample by factor and store result in separate file.
@@ -360,14 +362,14 @@ class Reader(CoreReader):
 
     def resample(
         self,
-        data_src: Union[h5py.Dataset, np.ndarray],
-        data_dst: Union[None, h5py.Dataset, np.ndarray],
+        data_src: h5py.Dataset | np.ndarray,
+        data_dst: None | h5py.Dataset | np.ndarray,
         start_n: int = 0,
-        end_n: Optional[int] = None,
+        end_n: int | None = None,
         samplerate_dst: float = 1000,
         *,
         is_time: bool = False,
-    ) -> Union[None, h5py.Dataset, np.ndarray]:
+    ) -> None | h5py.Dataset | np.ndarray:
         """Up- or down-sample the original trace-data.
 
         :param data_src: original iv-data
@@ -382,13 +384,17 @@ class Reader(CoreReader):
         if self.get_datatype() == EnergyDType.ivsurface:
             self._logger.warning("Resampling-Function was not written for IVSurfaces")
             return data_dst
-        if isinstance(end_n, (int, float)):
-            _end_n = min(data_src.shape[0], round(end_n))
+        if not isinstance(start_n, int):
+            raise TypeError("start_n must be an integer")
+        if isinstance(end_n, int):
+            end_n = min(data_src.shape[0], end_n)
+        elif isinstance(end_n, float):
+            raise TypeError("end_n must be an integer")
         else:
-            _end_n = data_src.shape[0]
+            end_n = data_src.shape[0]
 
-        start_n = min(_end_n, round(start_n))
-        data_len = _end_n - start_n
+        start_n = min(end_n, start_n)
+        data_len = end_n - start_n
         if data_len == 0:
             self._logger.warning("resampling failed because of data_len = 0")
             return data_dst
@@ -463,11 +469,11 @@ class Reader(CoreReader):
 
     def generate_plot_data(
         self,
-        start_s: Optional[float] = None,
-        end_s: Optional[float] = None,
+        start_s: float | None = None,
+        end_s: float | None = None,
         *,
         relative_timestamp: bool = True,
-    ) -> Optional[dict]:
+    ) -> dict | None:
         """Provide down-sampled iv-data that can be fed into plot_to_file().
 
         :param start_s: time in seconds, relative to start of recording
@@ -517,7 +523,7 @@ class Reader(CoreReader):
 
     @staticmethod
     def assemble_plot(
-        data: Union[Mapping, Sequence], width: int = 20, height: int = 10, *, only_pwr: bool = False
+        data: Mapping | Sequence, width: int = 20, height: int = 10, *, only_pwr: bool = False
     ) -> plt.Figure:
         """Create the actual figure.
 
@@ -575,8 +581,8 @@ class Reader(CoreReader):
 
     def plot_to_file(
         self,
-        start_s: Optional[float] = None,
-        end_s: Optional[float] = None,
+        start_s: float | None = None,
+        end_s: float | None = None,
         width: int = 20,
         height: int = 10,
         *,
@@ -619,7 +625,7 @@ class Reader(CoreReader):
         height: int = 10,
         *,
         only_pwr: bool = False,
-    ) -> Optional[Path]:
+    ) -> Path | None:
         """Create (down-sampled) IV-Multi-Plots (of more than one trace).
 
         :param data: plottable / down-sampled iv-data with some meta-data

{shepherd_data-2025.6.3.dist-info → shepherd_data-2025.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shepherd_data
-Version: 2025.6.3
+Version: 2025.8.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>
@@ -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.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -26,7 +25,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.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: click
 Requires-Dist: h5py
@@ -35,7 +34,7 @@ Requires-Dist: numpy
 Requires-Dist: pandas>=2.0.0
 Requires-Dist: pyYAML
 Requires-Dist: scipy
-Requires-Dist: shepherd-core[inventory]>=2025.06.3
+Requires-Dist: shepherd-core[inventory]>=2025.08.1
 Requires-Dist: tqdm
 Provides-Extra: elf
 Requires-Dist: shepherd-core[elf]; extra == "elf"
@@ -47,6 +46,8 @@ Requires-Dist: shepherd-core[test]; extra == "test"
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-click; extra == "test"
 Requires-Dist: coverage; extra == "test"
+Provides-Extra: all
+Requires-Dist: shepherd-data[dev,elf,test]; extra == "all"
 
 # Shepherd-Data-Tool
 

shepherd_data-2025.8.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+shepherd_data/__init__.py,sha256=oEhjHkoauQ5UG6iosVocZ1DpmjIp_MfNtgAvVuj5L4c,353
+shepherd_data/cli.py,sha256=CHlOIYMx1hcOukYUpK1LWrjj_7ESL0FKxJascVqnrqM,16118
+shepherd_data/ivonne.py,sha256=vh0XyMoSjbanzy4sqpNfVo6DEnbWNJPRUgNKPfHP2Yc,11875
+shepherd_data/mppt.py,sha256=y9gVIhMs-ZG3ScL9UQTc5n8T146B13Q5dA5sfqqfjg0,3999
+shepherd_data/reader.py,sha256=jHDPmLCZ-wDiIAlpLkyjguMdcueJ-TbqL6Nq7AxzPu0,25997
+shepherd_data-2025.8.1.dist-info/METADATA,sha256=BleD3ZIR6dUuFPPVPi9sgQkfZTyHT_gGj-6-ABuXhSw,3434
+shepherd_data-2025.8.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+shepherd_data-2025.8.1.dist-info/entry_points.txt,sha256=6PBfY36A1xNOdzLiz-Qoukya_UzFZAwOapwmRNnPeZ8,56
+shepherd_data-2025.8.1.dist-info/top_level.txt,sha256=7-SCTY-TG1mLY72OVKCaqte1hy-X8woxknIUAD3OIxs,14
+shepherd_data-2025.8.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+shepherd_data-2025.8.1.dist-info/RECORD,,

shepherd_data-2025.6.3.dist-info/RECORD

@@ -1,11 +0,0 @@
-shepherd_data/__init__.py,sha256=59AsLF1na1g6jQ1ZoFUCgaO_dMVJnrWpOKwW-jPAcwM,353
-shepherd_data/cli.py,sha256=8CShRsqJ5w6_nirNKInFEwYGv0gG5caXVLzExSeRGL4,15902
-shepherd_data/ivonne.py,sha256=sH7c2aj9i5ygkpw6xQbjRwrbl9wtU_Toj_ZFyJVywG8,11930
-shepherd_data/mppt.py,sha256=y9gVIhMs-ZG3ScL9UQTc5n8T146B13Q5dA5sfqqfjg0,3999
-shepherd_data/reader.py,sha256=NEIwXC5f5fkSiBEsyY85gIcgjhYHFS1tavNnA6ViE3k,25741
-shepherd_data-2025.6.3.dist-info/METADATA,sha256=YY0XjoqFMNNRHgg0a225ycvG7HYQH_-66Gxdo0UHnoI,3404
-shepherd_data-2025.6.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-shepherd_data-2025.6.3.dist-info/entry_points.txt,sha256=6PBfY36A1xNOdzLiz-Qoukya_UzFZAwOapwmRNnPeZ8,56
-shepherd_data-2025.6.3.dist-info/top_level.txt,sha256=7-SCTY-TG1mLY72OVKCaqte1hy-X8woxknIUAD3OIxs,14
-shepherd_data-2025.6.3.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-shepherd_data-2025.6.3.dist-info/RECORD,,