shepherd-data 2023.9.9__tar.gz → 2023.10.2__tar.gz

{shepherd_data-2023.9.9 → shepherd_data-2023.10.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shepherd_data
-Version: 2023.9.9
+Version: 2023.10.2
 Summary: Programming- and CLI-Interface for the h5-dataformat of the Shepherd-Testbed
 Home-page: https://pypi.org/project/shepherd-data/
 Author: Ingmar Splitt, Kai Geissdoerfer
@@ -20,20 +20,20 @@ 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.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Natural Language :: English
-Requires-Python: >=3.7
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: h5py
 Requires-Dist: numpy
 Requires-Dist: pyYAML
-Requires-Dist: shepherd-core[inventory]
+Requires-Dist: shepherd-core[inventory]>=2023.10.2
 Requires-Dist: click
 Requires-Dist: matplotlib
 Requires-Dist: pandas
@@ -51,7 +51,8 @@ Requires-Dist: pytest-click; extra == "test"
 # Data Module
 
 [![PyPiVersion](https://img.shields.io/pypi/v/shepherd_data.svg)](https://pypi.org/project/shepherd_data)
-[![Pytest](https://github.com/orgua/shepherd-datalib/actions/workflows/python-app.yml/badge.svg)](https://github.com/orgua/shepherd-datalib/actions/workflows/python-app.yml)
+[![image](https://img.shields.io/pypi/pyversions/shepherd_data.svg)](https://pypi.python.org/pypi/shepherd-data)
+[![Pytest](https://github.com/orgua/shepherd-datalib/actions/workflows/py_unittest.yml/badge.svg)](https://github.com/orgua/shepherd-datalib/actions/workflows/py_unittest.yml)
 [![CodeStyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 **Documentation**: <https://orgua.github.io/shepherd/external/shepherd_data.html>
@@ -141,7 +142,6 @@ with sd.Reader("./hrv_sawtooth_1h.h5") as db:
   - `is_valid`
   - `energy()`
   - `check_timediffs()`
-  - `data_timediffs()`
   - `get_metadata()`
   - `save_metadata()`
 

{shepherd_data-2023.9.9 → shepherd_data-2023.10.2}/README.md

@@ -1,7 +1,8 @@
 # Data Module
 
 [![PyPiVersion](https://img.shields.io/pypi/v/shepherd_data.svg)](https://pypi.org/project/shepherd_data)
-[![Pytest](https://github.com/orgua/shepherd-datalib/actions/workflows/python-app.yml/badge.svg)](https://github.com/orgua/shepherd-datalib/actions/workflows/python-app.yml)
+[![image](https://img.shields.io/pypi/pyversions/shepherd_data.svg)](https://pypi.python.org/pypi/shepherd-data)
+[![Pytest](https://github.com/orgua/shepherd-datalib/actions/workflows/py_unittest.yml/badge.svg)](https://github.com/orgua/shepherd-datalib/actions/workflows/py_unittest.yml)
 [![CodeStyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 **Documentation**: <https://orgua.github.io/shepherd/external/shepherd_data.html>
@@ -91,7 +92,6 @@ with sd.Reader("./hrv_sawtooth_1h.h5") as db:
   - `is_valid`
   - `energy()`
   - `check_timediffs()`
-  - `data_timediffs()`
   - `get_metadata()`
   - `save_metadata()`
 

{shepherd_data-2023.9.9 → shepherd_data-2023.10.2}/pyproject.toml

@@ -1,3 +1,7 @@
 [build-system]
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
+
+[tool.mypy]
+python_version = 3.8
+ignore_missing_imports = true

{shepherd_data-2023.9.9 → shepherd_data-2023.10.2}/setup.cfg

@@ -20,11 +20,11 @@ classifiers =
 	Intended Audience :: Developers
 	Intended Audience :: Information Technology
 	Intended Audience :: Science/Research
-	Programming Language :: Python :: 3.7
 	Programming Language :: Python :: 3.8
 	Programming Language :: Python :: 3.9
 	Programming Language :: Python :: 3.10
 	Programming Language :: Python :: 3.11
+	Programming Language :: Python :: 3.12
 	License :: OSI Approved :: MIT License
 	Operating System :: OS Independent
 	Natural Language :: English
@@ -35,12 +35,12 @@ package_dir =
 	=.
 zip_safe = True
 include_package_data = True
-python_requires = >= 3.7
+python_requires = >= 3.8
 install_requires = 
 	h5py
 	numpy
 	pyYAML
-	shepherd-core[inventory]
+	shepherd-core[inventory]>=2023.10.2
 	click
 	matplotlib
 	pandas  # V2 is OK
@@ -74,7 +74,7 @@ shepherd_data =
 test = pytest
 
 [tool:pytest]
-addopts = -vvv
+addopts = -vvv --stepwise
 
 [egg_info]
 tag_build = 

{shepherd_data-2023.9.9 → shepherd_data-2023.10.2}/shepherd_data/__init__.py

@@ -1,5 +1,4 @@
-"""
-shepherd.datalib
+"""shepherd.datalib
 ~~~~~
 Provides classes for storing and retrieving sampled IV data to/from
 HDF5 files.
@@ -9,7 +8,7 @@ from shepherd_core import Writer
 
 from .reader import Reader
 
-__version__ = "2023.9.9"
+__version__ = "2023.10.2"
 
 __all__ = [
     "Reader",

{shepherd_data-2023.9.9 → shepherd_data-2023.10.2}/shepherd_data/cli.py

@@ -1,9 +1,9 @@
-"""
-Command definitions for CLI
+"""Command definitions for CLI
 """
 import logging
 import os
 import sys
+from contextlib import suppress
 from datetime import datetime
 from pathlib import Path
 from typing import List
@@ -13,6 +13,7 @@ import click
 
 from shepherd_core import get_verbose_level
 from shepherd_core import increase_verbose_level
+from shepherd_core import local_tz
 from shepherd_core.commons import samplerate_sps_default
 
 from . import Reader
@@ -23,7 +24,7 @@ logger = logging.getLogger("SHPData.cli")
 
 
 def path_to_flist(data_path: Path) -> List[Path]:
-    """every path gets transformed to a list of paths
+    """Every path gets transformed to a list of paths
     - if directory: list of files inside
     - if existing file: list with 1 element
     - or else: empty list
@@ -36,7 +37,7 @@ def path_to_flist(data_path: Path) -> List[Path]:
         flist = os.listdir(data_path)
         for file in flist:
             fpath = data_path / str(file)
-            if not fpath.is_file() or ".h5" != fpath.suffix.lower():
+            if not fpath.is_file() or fpath.suffix.lower() != ".h5":
                 continue
             h5files.append(fpath)
     return h5files
@@ -55,7 +56,7 @@ def path_to_flist(data_path: Path) -> List[Path]:
     help="Prints version-info at start (combinable with -v)",
 )
 @click.pass_context  # TODO: is the ctx-type correct?
-def cli(ctx: click.Context, verbose: bool, version: bool) -> None:
+def cli(ctx: click.Context, verbose: bool, version: bool) -> None:  # noqa: FBT001
     """Shepherd: Synchronized Energy Harvesting Emulator and Recorder"""
     if verbose:
         increase_verbose_level(3)
@@ -77,12 +78,15 @@ def validate(in_data: Path) -> None:
     for file in files:
         logger.info("Validating '%s' ...", file.name)
         valid_file = True
-        with Reader(file, verbose=verbose_level > 2) as shpr:
-            valid_file &= shpr.is_valid()
-            valid_file &= shpr.check_timediffs()
-            valid_dir &= valid_file
-            if not valid_file:
-                logger.error(" -> File '%s' was NOT valid", file.name)
+        try:
+            with Reader(file, verbose=verbose_level > 2) as shpr:
+                valid_file &= shpr.is_valid()
+                valid_file &= shpr.check_timediffs()
+                valid_dir &= valid_file
+                if not valid_file:
+                    logger.error(" -> File '%s' was NOT valid", file.name)
+        except TypeError as _xpc:
+            logger.error("ERROR: will skip file, caught exception: %s", _xpc)
     sys.exit(int(not valid_dir))
 
 
@@ -111,34 +115,42 @@ def extract(in_data: Path, ds_factor: float, separator: str) -> None:
         logger.info("DS-Factor was invalid was reset to 1'000")
     for file in files:
         logger.info("Extracting IV-Samples from '%s' ...", file.name)
-        with Reader(file, verbose=verbose_level > 2) as shpr:
-            # will create a downsampled h5-file (if not existing) and then saving to csv
-            ds_file = file.with_suffix(f".downsampled_x{round(ds_factor)}.h5")
-            if not ds_file.exists():
-                logger.info("Downsampling '%s' by factor x%f ...", file.name, ds_factor)
-                with Writer(
-                    ds_file,
-                    mode=shpr.get_mode(),
-                    datatype=shpr.get_datatype(),
-                    window_samples=shpr.get_window_samples(),
-                    cal_data=shpr.get_calibration_data(),
-                    verbose=verbose_level > 2,
-                ) as shpw:
-                    shpw["ds_factor"] = ds_factor
-                    shpw.store_hostname(shpr.get_hostname())
-                    shpw.store_config(shpr.get_config())
-                    shpr.downsample(
-                        shpr.ds_time, shpw.ds_time, ds_factor=ds_factor, is_time=True
-                    )
-                    shpr.downsample(
-                        shpr.ds_voltage, shpw.ds_voltage, ds_factor=ds_factor
-                    )
-                    shpr.downsample(
-                        shpr.ds_current, shpw.ds_current, ds_factor=ds_factor
+        try:
+            with Reader(file, verbose=verbose_level > 2) as shpr:
+                # will create a downsampled h5-file (if not existing) and then saving to csv
+                ds_file = file.with_suffix(f".downsampled_x{round(ds_factor)}.h5")
+                if not ds_file.exists():
+                    logger.info(
+                        "Downsampling '%s' by factor x%f ...", file.name, ds_factor
                     )
+                    with Writer(
+                        ds_file,
+                        mode=shpr.get_mode(),
+                        datatype=shpr.get_datatype(),
+                        window_samples=shpr.get_window_samples(),
+                        cal_data=shpr.get_calibration_data(),
+                        verbose=verbose_level > 2,
+                    ) as shpw:
+                        shpw["ds_factor"] = ds_factor
+                        shpw.store_hostname(shpr.get_hostname())
+                        shpw.store_config(shpr.get_config())
+                        shpr.downsample(
+                            shpr.ds_time,
+                            shpw.ds_time,
+                            ds_factor=ds_factor,
+                            is_time=True,
+                        )
+                        shpr.downsample(
+                            shpr.ds_voltage, shpw.ds_voltage, ds_factor=ds_factor
+                        )
+                        shpr.downsample(
+                            shpr.ds_current, shpw.ds_current, ds_factor=ds_factor
+                        )
 
-            with Reader(ds_file, verbose=verbose_level > 2) as shpd:
-                shpd.save_csv(shpd["data"], separator)
+                with Reader(ds_file, verbose=verbose_level > 2) as shpd:
+                    shpd.save_csv(shpd["data"], separator)
+        except TypeError as _xpc:
+            logger.error("ERROR: will skip file, caught exception: %s", _xpc)
 
 
 @cli.command(
@@ -158,23 +170,22 @@ def extract_meta(in_data: Path, separator: str) -> None:
     verbose_level = get_verbose_level()
     for file in files:
         logger.info("Extracting metadata & logs from '%s' ...", file.name)
-        with Reader(file, verbose=verbose_level > 2) as shpr:
-            elements = shpr.save_metadata()
-            # TODO: add default exports (user-centric) and allow specifying --all or specific ones
-            # TODO: could also be combined with other extractors (just have one)
-            if "sysutil" in elements:
-                shpr.save_csv(shpr["sysutil"], separator)
-            if "timesync" in elements:
-                shpr.save_csv(shpr["timesync"], separator)
-
-            if "shepherd-log" in elements:
-                shpr.save_log(shpr["shepherd-log"])
-            if "dmesg" in elements:
-                shpr.save_log(shpr["dmesg"])
-            if "exceptions" in elements:
-                shpr.save_log(shpr["exceptions"])
-            if "uart" in elements:
-                shpr.save_log(shpr["uart"])
+        # TODO: add default exports (user-centric) and allow specifying --all or specific ones
+        # TODO: could also be combined with other extractors (just have one)
+        # TODO remove deprecated: timesync; "shepherd-log", "dmesg", "exceptions"
+        try:
+            with Reader(file, verbose=verbose_level > 2) as shpr:
+                elements = shpr.save_metadata()
+                for element in ["ptp", "sysutil", "timesync"]:
+                    if element in elements:
+                        shpr.save_csv(shpr[element], separator)
+                logs_depr = ["shepherd-log", "dmesg", "exceptions"]
+                logs = ["sheep", "kernel", "phc2sys", "uart"]
+                for element in logs + logs_depr:
+                    if element in elements:
+                        shpr.save_log(shpr[element])
+        except TypeError as _xpc:
+            logger.error("ERROR: will skip file, caught exception: %s", _xpc)
 
 
 @cli.command(
@@ -187,24 +198,29 @@ def extract_uart(in_data: Path) -> None:
     verbose_level = get_verbose_level()
     for file in files:
         logger.info("Extracting uart from gpio-trace from from '%s' ...", file.name)
-        with Reader(file, verbose=verbose_level > 2) as shpr:
-            # TODO: move into separate fn OR add to h5-file and use .save_log(), ALSO TEST
-            lines = shpr.gpio_to_uart()
-            # TODO: could also add parameter to get symbols instead of lines
-            log_path = Path(file).with_suffix(".uart_from_wf.log")
-            if log_path.exists():
-                logger.warning("%s already exists, will skip", log_path)
-                continue
+        try:
+            with Reader(file, verbose=verbose_level > 2) as shpr:
+                # TODO: move into separate fn OR add to h5-file and use .save_log(), ALSO TEST
+                lines = shpr.gpio_to_uart()
+                # TODO: could also add parameter to get symbols instead of lines
+                log_path = Path(file).with_suffix(".uart_from_wf.log")
+                if log_path.exists():
+                    logger.warning("%s already exists, will skip", log_path)
+                    continue
 
-            with open(log_path, "w") as log_file:
-                for line in lines:
-                    try:
-                        timestamp = datetime.utcfromtimestamp(float(line[0]))
-                        log_file.write(timestamp.strftime("%Y-%m-%d %H:%M:%S.%f") + ":")
-                        log_file.write(f"\t{str.encode(line[1])}")
-                        log_file.write("\n")
-                    except TypeError:
-                        continue
+                with log_path.open("w") as log_file:
+                    for line in lines:
+                        with suppress(TypeError):
+                            timestamp = datetime.fromtimestamp(
+                                float(line[0]), tz=local_tz()
+                            )
+                            log_file.write(
+                                timestamp.strftime("%Y-%m-%d %H:%M:%S.%f") + ":"
+                            )
+                            log_file.write(f"\t{str.encode(line[1])}")
+                            log_file.write("\n")
+        except TypeError as _xpc:
+            logger.error("ERROR: will skip file, caught exception: %s", _xpc)
 
 
 @cli.command(
@@ -224,10 +240,13 @@ def extract_gpio(in_data: Path, separator: str) -> None:
     verbose_level = get_verbose_level()
     for file in files:
         logger.info("Extracting gpio-trace from from '%s' ...", file.name)
-        with Reader(file, verbose=verbose_level > 2) as shpr:
-            wfs = shpr.gpio_to_waveforms()
-            for name, wf in wfs.items():
-                shpr.waveform_to_csv(name, wf, separator)
+        try:
+            with Reader(file, verbose=verbose_level > 2) as shpr:
+                wfs = shpr.gpio_to_waveforms()
+                for name, wf in wfs.items():
+                    shpr.waveform_to_csv(name, wf, separator)
+        except TypeError as _xpc:
+            logger.error("ERROR: will skip file, caught exception: %s", _xpc)
 
 
 @cli.command(
@@ -253,7 +272,8 @@ def downsample(
     in_data: Path, ds_factor: Optional[float], sample_rate: Optional[int]
 ) -> None:
     """Creates an array of downsampling-files from file
-    or directory containing shepherd-recordings"""
+    or directory containing shepherd-recordings
+    """
     if ds_factor is None and sample_rate is not None and sample_rate >= 1:
         ds_factor = int(samplerate_sps_default / sample_rate)
         # TODO: shouldn't current sps be based on file rather than default?
@@ -265,34 +285,44 @@ def downsample(
     files = path_to_flist(in_data)
     verbose_level = get_verbose_level()
     for file in files:
-        with Reader(file, verbose=verbose_level > 2) as shpr:
-            for _factor in ds_list:
-                if shpr.ds_time.shape[0] / _factor < 1000:
-                    logger.warning(
-                        "will skip downsampling for %s because resulting sample-size is too small",
-                        file.name,
-                    )
-                    break
-                ds_file = file.with_suffix(f".downsampled_x{round(_factor)}.h5")
-                if ds_file.exists():
-                    continue
-                logger.info("Downsampling '%s' by factor x%f ...", file.name, _factor)
-                with Writer(
-                    ds_file,
-                    mode=shpr.get_mode(),
-                    datatype=shpr.get_datatype(),
-                    window_samples=shpr.get_window_samples(),
-                    cal_data=shpr.get_calibration_data(),
-                    verbose=verbose_level > 2,
-                ) as shpw:
-                    shpw["ds_factor"] = _factor
-                    shpw.store_hostname(shpr.get_hostname())
-                    shpw.store_config(shpr.get_config())
-                    shpr.downsample(
-                        shpr.ds_time, shpw.ds_time, ds_factor=_factor, is_time=True
+        try:
+            with Reader(file, verbose=verbose_level > 2) as shpr:
+                for _factor in ds_list:
+                    if shpr.ds_time.shape[0] / _factor < 1000:
+                        logger.warning(
+                            "will skip downsampling for %s because "
+                            "resulting sample-size is too small",
+                            file.name,
+                        )
+                        break
+                    ds_file = file.with_suffix(f".downsampled_x{round(_factor)}.h5")
+                    if ds_file.exists():
+                        continue
+                    logger.info(
+                        "Downsampling '%s' by factor x%f ...", file.name, _factor
                     )
-                    shpr.downsample(shpr.ds_voltage, shpw.ds_voltage, ds_factor=_factor)
-                    shpr.downsample(shpr.ds_current, shpw.ds_current, ds_factor=_factor)
+                    with Writer(
+                        ds_file,
+                        mode=shpr.get_mode(),
+                        datatype=shpr.get_datatype(),
+                        window_samples=shpr.get_window_samples(),
+                        cal_data=shpr.get_calibration_data(),
+                        verbose=verbose_level > 2,
+                    ) as shpw:
+                        shpw["ds_factor"] = _factor
+                        shpw.store_hostname(shpr.get_hostname())
+                        shpw.store_config(shpr.get_config())
+                        shpr.downsample(
+                            shpr.ds_time, shpw.ds_time, ds_factor=_factor, is_time=True
+                        )
+                        shpr.downsample(
+                            shpr.ds_voltage, shpw.ds_voltage, ds_factor=_factor
+                        )
+                        shpr.downsample(
+                            shpr.ds_current, shpw.ds_current, ds_factor=_factor
+                        )
+        except TypeError as _xpc:
+            logger.error("ERROR: will skip file, caught exception: %s", _xpc)
 
 
 @cli.command(
@@ -339,7 +369,7 @@ def plot(
     end: Optional[float],
     width: int,
     height: int,
-    multiplot: bool,
+    multiplot: bool,  # noqa: FBT001
 ) -> None:
     """Plots IV-trace from file or directory containing shepherd-recordings"""
     files = path_to_flist(in_data)
@@ -348,11 +378,16 @@ def plot(
     data = []
     for file in files:
         logger.info("Generating plot for '%s' ...", file.name)
-        with Reader(file, verbose=verbose_level > 2) as shpr:
-            if multiplot:
-                data.append(shpr.generate_plot_data(start, end, relative_ts=True))
-            else:
-                shpr.plot_to_file(start, end, width, height)
+        try:
+            with Reader(file, verbose=verbose_level > 2) as shpr:
+                if multiplot:
+                    data.append(
+                        shpr.generate_plot_data(start, end, relative_timestamp=True)
+                    )
+                else:
+                    shpr.plot_to_file(start, end, width, height)
+        except TypeError as _xpc:
+            logger.error("ERROR: will skip file, caught exception: %s", _xpc)
     if multiplot:
         logger.info("Got %d datasets to plot", len(data))
         mpl_path = Reader.multiplot_to_file(data, in_data, width, height)

{shepherd_data-2023.9.9 → shepherd_data-2023.10.2}/shepherd_data/ivonne.py

@@ -1,5 +1,4 @@
-"""
-prototype of a file-reader with various converters
+"""prototype of a file-reader with various converters
 to generate valid shepherd-data for emulation
 
 """
@@ -7,13 +6,16 @@ import errno
 import logging
 import math
 import os
-import pickle  # noqa: S403
+import pickle
 from pathlib import Path
+from types import TracebackType
 from typing import Optional
+from typing import Type
 
 import numpy as np
 import pandas as pd
 from tqdm import trange
+from typing_extensions import Self
 
 from . import Writer
 from .mppt import MPPTracker
@@ -21,12 +23,12 @@ from .mppt import OptimalTracker
 from .mppt import iv_model
 
 
-def get_voc(coeffs: pd.DataFrame):
+def get_voc(coeffs: pd.DataFrame):  # noqa: ANN201
     """Open-circuit voltage of IV curve with given coefficients."""
     return np.log(coeffs["a"] / coeffs["b"] + 1) / coeffs["c"]
 
 
-def get_isc(coeffs: pd.DataFrame):
+def get_isc(coeffs: pd.DataFrame):  # noqa: ANN201
     """Short-circuit current of IV curve with given coefficients."""
     return coeffs["a"]
 
@@ -40,8 +42,9 @@ class Reader:
         self,
         file_path: Path,
         samplerate_sps: Optional[int] = None,
+        *,
         verbose: bool = True,
-    ):
+    ) -> None:
         self._logger.setLevel(logging.INFO if verbose else logging.WARNING)
 
         self.file_path = Path(file_path).resolve()
@@ -58,12 +61,12 @@ class Reader:
 
         self._df: Optional[pd.DataFrame] = None
 
-    def __enter__(self):
+    def __enter__(self) -> Self:
         if not self.file_path.exists():
             raise FileNotFoundError(
                 errno.ENOENT, os.strerror(errno.ENOENT), self.file_path.name
             )
-        with open(self.file_path, "rb") as ifr:
+        with self.file_path.open("rb") as ifr:
             self._df = pickle.load(ifr)  # noqa: S301
         self._refresh_file_stats()
         self._logger.info(
@@ -78,7 +81,13 @@ class Reader:
         )
         return self
 
-    def __exit__(self, *exc):  # type: ignore
+    def __exit__(
+        self,
+        typ: Optional[Type[BaseException]] = None,
+        exc: Optional[BaseException] = None,
+        tb: Optional[TracebackType] = None,
+        extra_arg: int = 0,
+    ) -> None:
         pass
 
     def _refresh_file_stats(self) -> None:
@@ -170,7 +179,8 @@ class Reader:
         file and applies the specified MPPT algorithm to extract the corresponding
         voltage and current traces.
 
-        TODO:
+        Todo:
+        ----
             - allow to use harvester-model in shepherd-code
             - generalize and put it into main code
 

{shepherd_data-2023.9.9 → shepherd_data-2023.10.2}/shepherd_data/mppt.py

@@ -1,5 +1,4 @@
-"""
-Harvesters, simple and fast approach.
+"""Harvesters, simple and fast approach.
 Might be exchanged by shepherds py-model of pru-harvesters
 """
 import numpy as np
@@ -12,10 +11,12 @@ def iv_model(voltages: Calc_t, coeffs: pd.Series) -> Calc_t:
     """Simple diode based model of a solar panel IV curve.
 
     Args:
+    ----
         :param voltages: Load voltage of the solar panel
         :param coeffs: three generic coefficients
 
     Returns:
+    -------
         Solar current at given load voltage
     """
     currents = float(coeffs["a"]) - float(coeffs["b"]) * (
@@ -29,7 +30,7 @@ def iv_model(voltages: Calc_t, coeffs: pd.Series) -> Calc_t:
     return currents
 
 
-def find_oc(v_arr: np.ndarray, i_arr: np.ndarray, ratio: float = 0.05):
+def find_oc(v_arr: np.ndarray, i_arr: np.ndarray, ratio: float = 0.05) -> np.ndarray:
     """Approximates opencircuit voltage.
 
     Searches last current value that is above a certain ratio of the short-circuit
@@ -45,18 +46,18 @@ class MPPTracker:
     :param pts_per_curve: resolution of internal ivcurve
     """
 
-    def __init__(self, v_max: float = 5.0, pts_per_curve: int = 1000):
+    def __init__(self, v_max: float = 5.0, pts_per_curve: int = 1000) -> None:
         self.pts_per_curve: int = pts_per_curve
         self.v_max: float = v_max
         self.v_proto: np.ndarray = np.linspace(0, v_max, pts_per_curve)
 
     def process(self, coeffs: pd.DataFrame) -> pd.DataFrame:
-        """apply harvesting model to input data
+        """Apply harvesting model to input data
 
         :param coeffs: ivonne coefficients
         :return:
         """
-        return pd.DataFrame()
+        pass
 
 
 class OpenCircuitTracker(MPPTracker):
@@ -69,7 +70,7 @@ class OpenCircuitTracker(MPPTracker):
 
     def __init__(
         self, v_max: float = 5.0, pts_per_curve: int = 1000, ratio: float = 0.8
-    ):
+    ) -> None:
         super().__init__(v_max, pts_per_curve)
         self.ratio = ratio
 
@@ -97,7 +98,7 @@ class OptimalTracker(MPPTracker):
     :param pts_per_curve: resolution of internal ivcurve
     """
 
-    def __init__(self, v_max: float = 5.0, pts_per_curve: int = 1000):
+    def __init__(self, v_max: float = 5.0, pts_per_curve: int = 1000) -> None:
         super().__init__(v_max, pts_per_curve)
 
     def process(self, coeffs: pd.DataFrame) -> pd.DataFrame:

{shepherd_data-2023.9.9 → shepherd_data-2023.10.2}/shepherd_data/reader.py

@@ -1,5 +1,4 @@
-"""
-Reader-Baseclass
+"""Reader-Baseclass
 """
 import math
 from datetime import datetime
@@ -14,24 +13,31 @@ from matplotlib import pyplot as plt
 from tqdm import trange
 
 from shepherd_core import Reader as CoreReader
+from shepherd_core import local_tz
 from shepherd_core.logger import logger
 
-# import samplerate  # TODO: just a test-fn for now
+# import samplerate  # noqa: ERA001, TODO: just a test-fn for now
 
 
 class Reader(CoreReader):
     """Sequentially Reads shepherd-data from HDF5 file.
 
     Args:
+    ----
         file_path: Path of hdf5 file containing shepherd data with iv-samples, iv-curves or isc&voc
         verbose: more info during usage, 'None' skips the setter
     """
 
-    def __init__(self, file_path: Optional[Path], verbose: Optional[bool] = True):
-        super().__init__(file_path, verbose)
+    def __init__(
+        self,
+        file_path: Optional[Path],
+        *,
+        verbose: Optional[bool] = True,
+    ) -> None:
+        super().__init__(file_path, verbose=verbose)
 
     def save_csv(self, h5_group: h5py.Group, separator: str = ";") -> int:
-        """extract numerical data via csv
+        """Extract numerical data via csv
 
         :param h5_group: can be external and should probably be downsampled
         :param separator: used between columns
@@ -47,24 +53,23 @@ class Reader(CoreReader):
             self._logger.warning("%s already exists, will skip", csv_path)
             return 0
         datasets = [
-            key if isinstance(h5_group[key], h5py.Dataset) else []
-            for key in h5_group.keys()
+            key if isinstance(h5_group[key], h5py.Dataset) else [] for key in h5_group
         ]
         datasets.remove("time")
-        datasets = ["time"] + datasets
+        datasets = ["time", *datasets]
         separator = separator.strip().ljust(2)
         header = [
             h5_group[key].attrs["description"].replace(", ", separator)
             for key in datasets
         ]
         header = separator.join(header)
-        with open(csv_path, "w", encoding="utf-8-sig") as csv_file:
+        with csv_path.open("w", encoding="utf-8-sig") as csv_file:
             self._logger.info(
                 "CSV-Generator will save '%s' to '%s'", h5_group.name, csv_path.name
             )
             csv_file.write(header + "\n")
             for idx, time_ns in enumerate(h5_group["time"][:]):
-                timestamp = datetime.utcfromtimestamp(time_ns / 1e9)
+                timestamp = datetime.fromtimestamp(time_ns / 1e9, tz=local_tz())
                 csv_file.write(timestamp.strftime("%Y-%m-%d %H:%M:%S.%f"))
                 for key in datasets[1:]:
                     values = h5_group[key][idx]
@@ -74,10 +79,11 @@ class Reader(CoreReader):
                 csv_file.write("\n")
         return h5_group["time"][:].shape[0]
 
-    def save_log(self, h5_group: h5py.Group) -> int:
-        """save dataset in group as log, optimal for logged dmesg and exceptions
+    def save_log(self, h5_group: h5py.Group, *, add_timestamp: bool = True) -> int:
+        """Save dataset in group as log, optimal for logged dmesg and exceptions
 
         :param h5_group: can be external
+        :param add_timestamp: can be external
         :return: number of processed entries
         """
         if h5_group["time"].shape[0] < 1:
@@ -90,17 +96,18 @@ class Reader(CoreReader):
             self._logger.warning("%s already exists, will skip", log_path)
             return 0
         datasets = [
-            key if isinstance(h5_group[key], h5py.Dataset) else []
-            for key in h5_group.keys()
+            key if isinstance(h5_group[key], h5py.Dataset) else [] for key in h5_group
         ]
         datasets.remove("time")
-        with open(log_path, "w", encoding="utf-8-sig") as log_file:
+        with log_path.open("w", encoding="utf-8-sig") as log_file:
             self._logger.info(
                 "Log-Generator will save '%s' to '%s'", h5_group.name, log_path.name
             )
             for idx, time_ns in enumerate(h5_group["time"][:]):
-                timestamp = datetime.utcfromtimestamp(time_ns / 1e9)
-                log_file.write(timestamp.strftime("%Y-%m-%d %H:%M:%S.%f") + ":")
+                if add_timestamp:
+                    timestamp = datetime.fromtimestamp(time_ns / 1e9, local_tz())
+                    # ⤷ TODO: these .fromtimestamp would benefit from included TZ
+                    log_file.write(timestamp.strftime("%Y-%m-%d %H:%M:%S.%f") + ":")
                 for key in datasets:
                     try:
                         message = str(h5_group[key][idx])
@@ -117,6 +124,7 @@ class Reader(CoreReader):
         start_n: int = 0,
         end_n: Optional[int] = None,
         ds_factor: float = 5,
+        *,
         is_time: bool = False,
     ) -> Union[h5py.Dataset, np.ndarray]:
         """Warning: only valid for IV-Stream, not IV-Curves
@@ -199,10 +207,10 @@ class Reader(CoreReader):
         start_n: int = 0,
         end_n: Optional[int] = None,
         samplerate_dst: float = 1000,
+        *,
         is_time: bool = False,
     ) -> Union[h5py.Dataset, np.ndarray]:
-        """
-        :param data_src:
+        """:param data_src:
         :param data_dst:
         :param start_n:
         :param end_n:
@@ -299,13 +307,14 @@ class Reader(CoreReader):
         self,
         start_s: Optional[float] = None,
         end_s: Optional[float] = None,
-        relative_ts: bool = True,
+        *,
+        relative_timestamp: bool = True,
     ) -> Dict:
-        """provides down-sampled iv-data that can be feed into plot_to_file()
+        """Provides down-sampled iv-data that can be feed into plot_to_file()
 
         :param start_s: time in seconds, relative to start of recording
         :param end_s: time in seconds, relative to start of recording
-        :param relative_ts: treat
+        :param relative_timestamp: treat
         :return: down-sampled size of ~ self.max_elements
         """
         if self.get_datatype() == "ivcurve":
@@ -343,7 +352,7 @@ class Reader(CoreReader):
             "start_s": start_s,
             "end_s": end_s,
         }
-        if relative_ts:
+        if relative_timestamp:
             data["time"] = data["time"] - self._cal.time.raw_to_si(self.ds_time[0])
         return data
 
@@ -351,8 +360,7 @@ class Reader(CoreReader):
     def assemble_plot(
         data: Union[dict, list], width: int = 20, height: int = 10
     ) -> plt.Figure:
-        """
-        TODO: add power (if wanted)
+        """TODO: add power (if wanted)
 
         :param data: plottable / down-sampled iv-data with some meta-data
                 -> created with generate_plot_data()
@@ -384,7 +392,7 @@ class Reader(CoreReader):
         width: int = 20,
         height: int = 10,
     ) -> None:
-        """creates (down-sampled) IV-Plot
+        """Creates (down-sampled) IV-Plot
             -> omitting start- and end-time will use the whole duration
 
         :param start_s: time in seconds, relative to start of recording, optional
@@ -415,7 +423,7 @@ class Reader(CoreReader):
     def multiplot_to_file(
         data: list, plot_path: Path, width: int = 20, height: int = 10
     ) -> Optional[Path]:
-        """creates (down-sampled) IV-Multi-Plot
+        """Creates (down-sampled) IV-Multi-Plot
 
         :param data: plottable / down-sampled iv-data with some meta-data
             -> created with generate_plot_data()

{shepherd_data-2023.9.9 → shepherd_data-2023.10.2}/shepherd_data.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shepherd-data
-Version: 2023.9.9
+Version: 2023.10.2
 Summary: Programming- and CLI-Interface for the h5-dataformat of the Shepherd-Testbed
 Home-page: https://pypi.org/project/shepherd-data/
 Author: Ingmar Splitt, Kai Geissdoerfer
@@ -20,20 +20,20 @@ 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.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Natural Language :: English
-Requires-Python: >=3.7
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: h5py
 Requires-Dist: numpy
 Requires-Dist: pyYAML
-Requires-Dist: shepherd-core[inventory]
+Requires-Dist: shepherd-core[inventory]>=2023.10.2
 Requires-Dist: click
 Requires-Dist: matplotlib
 Requires-Dist: pandas
@@ -51,7 +51,8 @@ Requires-Dist: pytest-click; extra == "test"
 # Data Module
 
 [![PyPiVersion](https://img.shields.io/pypi/v/shepherd_data.svg)](https://pypi.org/project/shepherd_data)
-[![Pytest](https://github.com/orgua/shepherd-datalib/actions/workflows/python-app.yml/badge.svg)](https://github.com/orgua/shepherd-datalib/actions/workflows/python-app.yml)
+[![image](https://img.shields.io/pypi/pyversions/shepherd_data.svg)](https://pypi.python.org/pypi/shepherd-data)
+[![Pytest](https://github.com/orgua/shepherd-datalib/actions/workflows/py_unittest.yml/badge.svg)](https://github.com/orgua/shepherd-datalib/actions/workflows/py_unittest.yml)
 [![CodeStyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 **Documentation**: <https://orgua.github.io/shepherd/external/shepherd_data.html>
@@ -141,7 +142,6 @@ with sd.Reader("./hrv_sawtooth_1h.h5") as db:
   - `is_valid`
   - `energy()`
   - `check_timediffs()`
-  - `data_timediffs()`
   - `get_metadata()`
   - `save_metadata()`
 

{shepherd_data-2023.9.9 → shepherd_data-2023.10.2}/shepherd_data.egg-info/requires.txt

@@ -1,7 +1,7 @@
 h5py
 numpy
 pyYAML
-shepherd-core[inventory]
+shepherd-core[inventory]>=2023.10.2
 click
 matplotlib
 pandas

{shepherd_data-2023.9.9 → shepherd_data-2023.10.2}/tests/test_cli.py

@@ -3,6 +3,6 @@ from click.testing import CliRunner
 from shepherd_data.cli import cli
 
 
-def test_cli_invoke_help():
+def test_cli_invoke_help() -> None:
     res = CliRunner().invoke(cli, ["-h"])
     assert res.exit_code == 0