shepherd-data 2023.12.1__tar.gz → 2024.4.1__tar.gz

shepherd_data-2024.4.1/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.1
+Name: shepherd_data
+Version: 2024.4.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>
+Project-URL: Documentation, https://github.com/orgua/shepherd-datalib/blob/main/README.md
+Project-URL: Issues, https://pypi.org/project/shepherd-data/issues
+Project-URL: Source, https://pypi.org/project/shepherd-data/
+Keywords: testbed,beaglebone,pru,batteryless,energyharvesting,solar
+Platform: unix
+Platform: linux
+Platform: osx
+Platform: cygwin
+Platform: win32
+Platform: win64
+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
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Natural Language :: English
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: click
+Requires-Dist: h5py
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: pyYAML
+Requires-Dist: scipy
+Requires-Dist: shepherd-core[inventory]>=2024.04.1
+Requires-Dist: tqdm
+Provides-Extra: elf
+Requires-Dist: shepherd-core[elf]; extra == "elf"
+Provides-Extra: dev
+Requires-Dist: shepherd-core[dev]; extra == "dev"
+Requires-Dist: pandas-stubs; extra == "dev"
+Provides-Extra: test
+Requires-Dist: shepherd-core[test]; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-click; extra == "test"
+Requires-Dist: coverage; extra == "test"
+
+# Shepherd-Data-Tool
+
+[![PyPiVersion](https://img.shields.io/pypi/v/shepherd_data.svg)](https://pypi.org/project/shepherd_data)
+[![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/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+**Main Documentation**: <https://orgua.github.io/shepherd>
+
+**Source Code**: <https://github.com/orgua/shepherd-datalib>
+
+**Main Project**: <https://github.com/orgua/shepherd>
+
+---
+
+`shepherd-data` eases the handling of hdf5-recordings used by the [shepherd](https://github.com/orgua/shepherd)-testbed. Users can read, validate and create files and also extract, down-sample and plot information.
+
+## Installation
+
+### PIP - Online
+
+```shell
+pip3 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_data -U
+```
+
+## More
+
+Please consult the [official documentation](https://orgua.github.io/shepherd) for more, it covers:
+
+- general context
+- command-line interface
+- programming interface

shepherd_data-2024.4.1/README.md

@@ -0,0 +1,38 @@
+# Shepherd-Data-Tool
+
+[![PyPiVersion](https://img.shields.io/pypi/v/shepherd_data.svg)](https://pypi.org/project/shepherd_data)
+[![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/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+**Main Documentation**: <https://orgua.github.io/shepherd>
+
+**Source Code**: <https://github.com/orgua/shepherd-datalib>
+
+**Main Project**: <https://github.com/orgua/shepherd>
+
+---
+
+`shepherd-data` eases the handling of hdf5-recordings used by the [shepherd](https://github.com/orgua/shepherd)-testbed. Users can read, validate and create files and also extract, down-sample and plot information.
+
+## Installation
+
+### PIP - Online
+
+```shell
+pip3 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_data -U
+```
+
+## More
+
+Please consult the [official documentation](https://orgua.github.io/shepherd) for more, it covers:
+
+- general context
+- command-line interface
+- programming interface

shepherd_data-2024.4.1/pyproject.toml

@@ -0,0 +1,101 @@
+[project]
+name = "shepherd_data"
+description = "Programming- and CLI-Interface for the h5-dataformat of the Shepherd-Testbed"
+keywords = ["testbed", "beaglebone", "pru", "batteryless", "energyharvesting", "solar"]
+
+authors = [
+    {name = "Ingmar Splitt", email = "ingmar.splitt@tu-dresden.de"},
+]
+maintainers = [
+    {name = "Ingmar Splitt", email = "ingmar.splitt@tu-dresden.de"},
+]
+
+readme = {file = "README.md", content-type = "text/markdown"}
+license = {file = "LICENSE"}
+dynamic = ["version"]
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "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",
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Natural Language :: English",
+]
+
+requires-python = ">=3.8"
+dependencies = [
+    "click",
+    "h5py",
+    "matplotlib",  # full-version
+    "numpy",
+    "pandas>=2.0.0",  # full-version, v2 is OK
+    "pyYAML",
+    "scipy",   # full-version
+    "shepherd-core[inventory]>=2024.04.1",
+    "tqdm",    # full-version
+]
+
+[project.optional-dependencies]
+elf = [
+    "shepherd-core[elf]"
+]
+
+dev = [
+    "shepherd-core[dev]",
+    "pandas-stubs",  # for pyright with pandas
+]
+
+test = [
+    "shepherd-core[test]",
+    "pytest",
+    "pytest-click",
+    "coverage",
+]
+
+[project.urls]
+Documentation = "https://github.com/orgua/shepherd-datalib/blob/main/README.md"
+Issues = "https://pypi.org/project/shepherd-data/issues"
+Source = "https://pypi.org/project/shepherd-data/"
+
+[project.scripts]
+shepherd-data = "shepherd_data.cli:cli"
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+platforms = ["unix", "linux", "osx", "cygwin", "win32", "win64"]
+zip-safe = true
+#include-package-data = true
+
+[tool.setuptools.package-dir]
+shepherd_data = "shepherd_data"
+
+[tool.setuptools.package-data]
+shepherd_data = [
+    "README.md",
+    "src/examples/*.py",
+    "src/examples/*.iv",
+]
+
+[tool.setuptools.dynamic]
+version = {attr = "shepherd_data.__version__"}
+
+[tool.pytest.ini_options]
+addopts = "-vvv --stepwise" # opts: verbose result for each tests
+# TODO: add something like "--cov --cov-report html --cov-report term-missing --cov-fail-under 95"
+
+[tool.coverage.run]
+source = ["shepherd_data"]
+
+[tool.mypy]
+python_version = 3.8
+ignore_missing_imports = true

shepherd_data-2024.4.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

{shepherd_data-2023.12.1 → shepherd_data-2024.4.1}/shepherd_data/__init__.py

@@ -4,11 +4,12 @@ Provides classes for storing and retrieving sampled IV data to/from
 HDF5 files.
 
 """
+
 from shepherd_core import Writer
 
 from .reader import Reader
 
-__version__ = "2023.12.1"
+__version__ = "2024.04.1"
 
 __all__ = [
     "Reader",

{shepherd_data-2023.12.1 → shepherd_data-2024.4.1}/shepherd_data/cli.py

@@ -1,5 +1,5 @@
-"""Command definitions for CLI
-"""
+"""Command definitions for CLI"""
+
 import logging
 import os
 import sys
@@ -365,7 +365,7 @@ def plot(
                 else:
                     shpr.plot_to_file(start, end, width, height)
         except TypeError as _xpc:
-            logger.error("ERROR: will skip file, caught exception: %s", _xpc)
+            logger.exception("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.12.1 → shepherd_data-2024.4.1}/shepherd_data/ivonne.py

@@ -2,6 +2,7 @@
 to generate valid shepherd-data for emulation
 
 """
+
 import errno
 import logging
 import math
@@ -34,7 +35,7 @@ def get_isc(coeffs: pd.DataFrame):  # noqa: ANN201
 
 
 class Reader:
-    """container for converters to shepherd-data"""
+    """Container for converters that bridge the gap to shepherds data-files."""
 
     _logger: logging.Logger = logging.getLogger("SHPData.IVonne.Reader")
 
@@ -102,8 +103,9 @@ class Reader:
         pts_per_curve: int = 1000,
         duration_s: Optional[float] = None,
     ) -> None:
-        """Transforms previously recorded parameters to shepherd hdf database with IV curves.
-        Shepherd should work with IV 'surfaces', where we have a stream of IV curves
+        """Transform recorded parameters to shepherd hdf database with IV curves.
+
+        Shepherd works with IV 'surfaces', which is a stream of IV curves.
 
         :param shp_output: Path where the resulting hdf file shall be stored
         :param v_max: Maximum voltage supported by shepherd
@@ -134,7 +136,7 @@ class Reader:
             for idx in job_iter:
                 idx_top = min(idx + max_elements, df_elements_n)
                 df_slice = self._df.iloc[idx : idx_top + 1].copy()
-                df_slice["timestamp"] = pd.TimedeltaIndex(data=df_slice["time"], unit="s")
+                df_slice["timestamp"] = pd.to_timedelta(df_slice["time"], unit="s")
                 df_slice = df_slice.set_index("timestamp")
                 # warning: .interpolate does crash in debug-mode with typeError
                 df_slice = (
@@ -163,7 +165,7 @@ class Reader:
         duration_s: Optional[float] = None,
         tracker: Optional[MPPTracker] = None,
     ) -> None:
-        """Transforms shepherd IV curves to shepherd IV traces.
+        """Transform shepherd IV curves to shepherd IV samples / traces.
 
         For the 'buck' and 'buck-boost' modes, shepherd takes voltage and current traces.
         These can be recorded with shepherd or generated from existing IV curves by, for
@@ -180,6 +182,7 @@ class Reader:
         :param v_max: Maximum voltage supported by shepherd
         :param duration_s: time to stop in seconds, counted from beginning
         :param tracker: VOC or OPT
+
         """
         if self._df is None:
             raise RuntimeError("IVonne Context was not entered - file not open!")
@@ -213,7 +216,7 @@ class Reader:
                 df_slice.loc[:, "voc"] = get_voc(df_slice)
                 df_slice.loc[df_slice["voc"] >= v_max, "voc"] = v_max
                 df_slice = tracker.process(df_slice)
-                df_slice["timestamp"] = pd.TimedeltaIndex(data=df_slice["time"], unit="s")
+                df_slice["timestamp"] = pd.to_timedelta(df_slice["time"], unit="s")
                 df_slice = df_slice[["time", "v", "i", "timestamp"]].set_index("timestamp")
                 # warning: .interpolate does crash in debug-mode with typeError
                 df_slice = (
@@ -231,7 +234,7 @@ class Reader:
         v_max: float = 5.0,
         duration_s: Optional[float] = None,
     ) -> None:
-        """Transforms ivonne-parameters to upsampled version for shepherd
+        """Transform ivonne-parameters to up-sampled versions for shepherd.
 
         :param shp_output: Path where the resulting hdf file shall be stored
         :param v_max: Maximum voltage supported by shepherd
@@ -264,7 +267,7 @@ class Reader:
                 df_slice.loc[:, "voc"] = get_voc(df_slice)
                 df_slice.loc[df_slice["voc"] >= v_max, "voc"] = v_max
                 df_slice.loc[:, "isc"] = get_isc(df_slice)
-                df_slice["timestamp"] = pd.TimedeltaIndex(data=df_slice["time"], unit="s")
+                df_slice["timestamp"] = pd.to_timedelta(df_slice["time"], unit="s")
                 df_slice = df_slice[["time", "voc", "isc", "timestamp"]].set_index("timestamp")
                 # warning: .interpolate does crash in debug-mode with typeError
                 df_slice = (

{shepherd_data-2023.12.1 → shepherd_data-2024.4.1}/shepherd_data/mppt.py

@@ -1,6 +1,8 @@
 """Harvesters, simple and fast approach.
-Might be exchanged by shepherds py-model of pru-harvesters
+
+Might be exchanged by shepherds py-model of pru-harvesters.
 """
+
 import numpy as np
 import pandas as pd
 
@@ -8,16 +10,11 @@ from shepherd_core import Calc_t
 
 
 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
+    """Calculate simple diode based model (equivalent circuit diagram) of a solar panel IV curve.
 
-    Returns:
-    -------
-        Solar current at given load voltage
+    :param voltages: Load voltage of the solar panel
+    :param coeffs: three generic coefficients
+    :return: Solar current at given load voltage
     """
     currents = float(coeffs["a"]) - float(coeffs["b"]) * (
         np.exp(float(coeffs["c"]) * voltages) - 1.0
@@ -40,7 +37,7 @@ def find_oc(v_arr: np.ndarray, i_arr: np.ndarray, ratio: float = 0.05) -> np.nda
 
 
 class MPPTracker:
-    """Prototype
+    """Prototype for a MPPT-class.
 
     :param v_max: Maximum voltage supported by shepherd
     :param pts_per_curve: resolution of internal ivcurve
@@ -52,15 +49,15 @@ class MPPTracker:
         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: ivsample-data
         """
 
 
 class OpenCircuitTracker(MPPTracker):
-    """Open-circuit based MPPT
+    """Open-circuit (-voltage) based MPPT.
 
     :param v_max: Maximum voltage supported by shepherd
     :param pts_per_curve: resolution of internal ivcurve
@@ -72,6 +69,11 @@ class OpenCircuitTracker(MPPTracker):
         self.ratio = ratio
 
     def process(self, coeffs: pd.DataFrame) -> pd.DataFrame:
+        """Apply harvesting model to input data.
+
+        :param coeffs: ivonne coefficients
+        :return: ivsample-data
+        """
         coeffs["icurve"] = coeffs.apply(lambda x: iv_model(self.v_proto, x), axis=1)
         if "voc" not in coeffs.columns:
             coeffs["voc"] = coeffs.apply(lambda x: find_oc(self.v_proto, x["ivcurve"]), axis=1)
@@ -85,7 +87,7 @@ class OpenCircuitTracker(MPPTracker):
 
 
 class OptimalTracker(MPPTracker):
-    """Optimal MPPT
+    """Optimal MPPT by looking at the whole curve.
 
     Calculates optimal harvesting voltage for every time and corresponding IV curve.
 
@@ -97,6 +99,11 @@ class OptimalTracker(MPPTracker):
         super().__init__(v_max, pts_per_curve)
 
     def process(self, coeffs: pd.DataFrame) -> pd.DataFrame:
+        """Apply harvesting model to input data.
+
+        :param coeffs: ivonne coefficients
+        :return: ivsample-data
+        """
         coeffs["icurve"] = coeffs.apply(lambda x: iv_model(self.v_proto, x), axis=1)
         coeffs["pcurve"] = coeffs.apply(lambda x: self.v_proto * x["icurve"], axis=1)
         coeffs["max_pos"] = coeffs.apply(lambda x: np.argmax(x["pcurve"]), axis=1)

{shepherd_data-2023.12.1 → shepherd_data-2024.4.1}/shepherd_data/reader.py

@@ -1,5 +1,5 @@
-"""Reader-Baseclass
-"""
+"""Reader-Baseclass for opening shepherds hdf5-files."""
+
 import math
 from datetime import datetime
 from pathlib import Path
@@ -26,6 +26,7 @@ class Reader(CoreReader):
     ----
         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__(
@@ -37,7 +38,7 @@ class Reader(CoreReader):
         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 from group and store it into csv.
 
         :param h5_group: can be external and should probably be downsampled
         :param separator: used between columns
@@ -73,7 +74,7 @@ class Reader(CoreReader):
         return h5_group["time"][:].shape[0]
 
     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
+        """Save dataset from group as log, optimal for logged 'dmesg' and console-output.
 
         :param h5_group: can be external
         :param add_timestamp: can be external
@@ -114,6 +115,7 @@ class Reader(CoreReader):
         *,
         show: bool = True,
     ) -> int:
+        """Print warning messages from log in data-group."""
         _count = self.count_errors_in_log(group_name, min_level)
         if _count < 1:
             return 0
@@ -145,7 +147,7 @@ class Reader(CoreReader):
 
     def downsample(
         self,
-        data_src: h5py.Dataset,
+        data_src: Union[h5py.Dataset, np.ndarray],
         data_dst: Union[None, h5py.Dataset, np.ndarray],
         start_n: int = 0,
         end_n: Optional[int] = None,
@@ -153,15 +155,17 @@ class Reader(CoreReader):
         *,
         is_time: bool = False,
     ) -> Union[h5py.Dataset, np.ndarray]:
-        """Warning: only valid for IV-Stream, not IV-Curves
+        """Sample down iv-data.
+
+        Warning: only valid for IV-Stream, not IV-Curves
 
         :param data_src: a h5-dataset to digest, can be external
         :param data_dst: can be a dataset, numpy-array or None (will be created internally then)
         :param start_n: start-sample
         :param end_n: ending-sample (not included)
-        :param ds_factor: downsampling-factor
-        :param is_time: time is not really downsamples, but just decimated
-        :return: downsampled h5-dataset or numpy-array
+        :param ds_factor: sampling-factor
+        :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
 
@@ -222,7 +226,7 @@ class Reader(CoreReader):
 
     def resample(
         self,
-        data_src: h5py.Dataset,
+        data_src: Union[h5py.Dataset, np.ndarray],
         data_dst: Union[None, h5py.Dataset, np.ndarray],
         start_n: int = 0,
         end_n: Optional[int] = None,
@@ -230,13 +234,15 @@ class Reader(CoreReader):
         *,
         is_time: bool = False,
     ) -> Union[h5py.Dataset, np.ndarray]:
-        """:param data_src:
-        :param data_dst:
-        :param start_n:
-        :param end_n:
-        :param samplerate_dst:
-        :param is_time:
-        :return:
+        """Up- or down-sample the original trace-data.
+
+        :param data_src: original iv-data
+        :param data_dst: resampled iv-traces
+        :param start_n: start index of the source
+        :param end_n: end index of the source
+        :param samplerate_dst: desired sampling rate
+        :param is_time: time-array is handled differently than IV-Samples
+        :return: resampled iv-data
         """
         self._logger.error("Resampling is still under construction - do not use for now!")
         if self.get_datatype() == "ivcurve":
@@ -327,7 +333,7 @@ class Reader(CoreReader):
         *,
         relative_timestamp: bool = True,
     ) -> Dict:
-        """Provides down-sampled iv-data that can be feed into plot_to_file()
+        """Provide down-sampled iv-data that can be fed 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
@@ -371,14 +377,15 @@ class Reader(CoreReader):
 
     @staticmethod
     def assemble_plot(data: Union[dict, list], width: int = 20, height: int = 10) -> plt.Figure:
-        """TODO: add power (if wanted)
+        """Create the actual figure.
 
         :param data: plottable / down-sampled iv-data with some meta-data
                 -> created with generate_plot_data()
         :param width: plot-width
         :param height: plot-height
-        :return:
+        :return: figure
         """
+        # TODO: add power (if wanted)
         if isinstance(data, dict):
             data = [data]
         fig, axes = plt.subplots(2, 1, sharex="all")
@@ -403,8 +410,9 @@ class Reader(CoreReader):
         width: int = 20,
         height: int = 10,
     ) -> None:
-        """Creates (down-sampled) IV-Plot
-            -> omitting start- and end-time will use the whole duration
+        """Create (down-sampled) IV-Plots.
+
+        Omitting start- and end-time will use the whole trace (full duration).
 
         :param start_s: time in seconds, relative to start of recording, optional
         :param end_s: time in seconds, relative to start of recording, optional
@@ -432,7 +440,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
+        """Create (down-sampled) IV-Multi-Plots (of more than one trace).
 
         :param data: plottable / down-sampled iv-data with some meta-data
             -> created with generate_plot_data()

shepherd_data-2024.4.1/shepherd_data.egg-info/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.1
+Name: shepherd_data
+Version: 2024.4.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>
+Project-URL: Documentation, https://github.com/orgua/shepherd-datalib/blob/main/README.md
+Project-URL: Issues, https://pypi.org/project/shepherd-data/issues
+Project-URL: Source, https://pypi.org/project/shepherd-data/
+Keywords: testbed,beaglebone,pru,batteryless,energyharvesting,solar
+Platform: unix
+Platform: linux
+Platform: osx
+Platform: cygwin
+Platform: win32
+Platform: win64
+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
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Natural Language :: English
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: click
+Requires-Dist: h5py
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: pyYAML
+Requires-Dist: scipy
+Requires-Dist: shepherd-core[inventory]>=2024.04.1
+Requires-Dist: tqdm
+Provides-Extra: elf
+Requires-Dist: shepherd-core[elf]; extra == "elf"
+Provides-Extra: dev
+Requires-Dist: shepherd-core[dev]; extra == "dev"
+Requires-Dist: pandas-stubs; extra == "dev"
+Provides-Extra: test
+Requires-Dist: shepherd-core[test]; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-click; extra == "test"
+Requires-Dist: coverage; extra == "test"
+
+# Shepherd-Data-Tool
+
+[![PyPiVersion](https://img.shields.io/pypi/v/shepherd_data.svg)](https://pypi.org/project/shepherd_data)
+[![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/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+**Main Documentation**: <https://orgua.github.io/shepherd>
+
+**Source Code**: <https://github.com/orgua/shepherd-datalib>
+
+**Main Project**: <https://github.com/orgua/shepherd>
+
+---
+
+`shepherd-data` eases the handling of hdf5-recordings used by the [shepherd](https://github.com/orgua/shepherd)-testbed. Users can read, validate and create files and also extract, down-sample and plot information.
+
+## Installation
+
+### PIP - Online
+
+```shell
+pip3 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_data -U
+```
+
+## More
+
+Please consult the [official documentation](https://orgua.github.io/shepherd) for more, it covers:
+
+- general context
+- command-line interface
+- programming interface