shepherd-data 2023.11.1__py3-none-any.whl → 2024.4.1__py3-none-any.whl

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
@@ -52,21 +53,14 @@ class Reader(CoreReader):
         if csv_path.exists():
             self._logger.info("File already exists, will skip '%s'", csv_path.name)
             return 0
-        datasets = [
-            key if isinstance(h5_group[key], h5py.Dataset) else [] for key in h5_group
-        ]
+        datasets = [key if isinstance(h5_group[key], h5py.Dataset) else [] for key in h5_group]
         datasets.remove("time")
         datasets = ["time", *datasets]
         separator = separator.strip().ljust(2)
-        header = [
-            h5_group[key].attrs["description"].replace(", ", separator)
-            for key in datasets
-        ]
+        header = [h5_group[key].attrs["description"].replace(", ", separator) for key in datasets]
         header = separator.join(header)
         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
-            )
+            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.fromtimestamp(time_ns / 1e9, tz=local_tz())
@@ -80,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
@@ -95,14 +89,10 @@ class Reader(CoreReader):
         if log_path.exists():
             self._logger.info("File already exists, will skip '%s'", log_path.name)
             return 0
-        datasets = [
-            key if isinstance(h5_group[key], h5py.Dataset) else [] for key in h5_group
-        ]
+        datasets = [key if isinstance(h5_group[key], h5py.Dataset) else [] for key in h5_group]
         datasets.remove("time")
         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
-            )
+            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"][:]):
                 if add_timestamp:
                     timestamp = datetime.fromtimestamp(time_ns / 1e9, local_tz())
@@ -125,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
@@ -156,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,
@@ -164,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
 
@@ -219,27 +212,21 @@ class Reader(CoreReader):
             leave=False,
             disable=iterations < 8,
         ):
-            slice_ds = data_src[
-                start_n + _iter * iblock_len : start_n + (_iter + 1) * iblock_len
-            ]
+            slice_ds = data_src[start_n + _iter * iblock_len : start_n + (_iter + 1) * iblock_len]
             if not is_time and ds_factor > 1:
                 slice_ds, f_state = signal.sosfilt(filter_, slice_ds, zi=f_state)
             slice_ds = slice_ds[::ds_factor]
             slice_len = min(dest_len - _iter * oblock_len, oblock_len)
-            data_dst[_iter * oblock_len : (_iter + 1) * oblock_len] = slice_ds[
-                :slice_len
-            ]
+            data_dst[_iter * oblock_len : (_iter + 1) * oblock_len] = slice_ds[:slice_len]
         if isinstance(data_dst, np.ndarray):
-            data_dst.resize(
-                (oblock_len * (iterations - 1) + slice_len,), refcheck=False
-            )
+            data_dst.resize((oblock_len * (iterations - 1) + slice_len,), refcheck=False)
         else:
             data_dst.resize((oblock_len * (iterations - 1) + slice_len,))
         return data_dst
 
     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,
@@ -247,17 +234,17 @@ 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!"
-        )
+        self._logger.error("Resampling is still under construction - do not use for now!")
         if self.get_datatype() == "ivcurve":
             self._logger.warning("Resampling-Function was not written for IVCurves")
 
@@ -331,7 +318,6 @@ class Reader(CoreReader):
                 slice_out_now = slice_out_nxt
             resampler.reset()
             """
-            pass
 
         if isinstance(data_dst, np.ndarray):
             data_dst.resize((slice_out_now,), refcheck=False)
@@ -347,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
@@ -377,14 +363,10 @@ class Reader(CoreReader):
                 )
             ).astype(float),
             "voltage": self._cal.voltage.raw_to_si(
-                self.downsample(
-                    self.ds_voltage, None, start_sample, end_sample, ds_factor
-                )
+                self.downsample(self.ds_voltage, None, start_sample, end_sample, ds_factor)
             ),
             "current": self._cal.current.raw_to_si(
-                self.downsample(
-                    self.ds_current, None, start_sample, end_sample, ds_factor
-                )
+                self.downsample(self.ds_current, None, start_sample, end_sample, ds_factor)
             ),
             "start_s": start_s,
             "end_s": end_s,
@@ -394,17 +376,16 @@ class Reader(CoreReader):
         return data
 
     @staticmethod
-    def assemble_plot(
-        data: Union[dict, list], width: int = 20, height: int = 10
-    ) -> plt.Figure:
-        """TODO: add power (if wanted)
+    def assemble_plot(data: Union[dict, list], width: int = 20, height: int = 10) -> plt.Figure:
+        """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")
@@ -429,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
@@ -444,9 +426,7 @@ class Reader(CoreReader):
 
         start_str = f"{data[0]['start_s']:.3f}".replace(".", "s")
         end_str = f"{data[0]['end_s']:.3f}".replace(".", "s")
-        plot_path = self.file_path.resolve().with_suffix(
-            f".plot_{start_str}_to_{end_str}.png"
-        )
+        plot_path = self.file_path.resolve().with_suffix(f".plot_{start_str}_to_{end_str}.png")
         if plot_path.exists():
             self._logger.warning("Plot exists, will skip & not overwrite!")
             return
@@ -460,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()
@@ -471,9 +451,7 @@ class Reader(CoreReader):
         start_str = f"{data[0]['start_s']:.3f}".replace(".", "s")
         end_str = f"{data[0]['end_s']:.3f}".replace(".", "s")
         plot_path = (
-            Path(plot_path)
-            .resolve()
-            .with_suffix(f".multiplot_{start_str}_to_{end_str}.png")
+            Path(plot_path).resolve().with_suffix(f".multiplot_{start_str}_to_{end_str}.png")
         )
         if plot_path.exists():
             logger.warning("Plot exists, will skip & not overwrite!")

shepherd_data-2024.4.1.dist-info/METADATA

@@ -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: dev
+Requires-Dist: shepherd-core[dev] ; extra == 'dev'
+Requires-Dist: pandas-stubs ; extra == 'dev'
+Provides-Extra: elf
+Requires-Dist: shepherd-core[elf] ; extra == 'elf'
+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.dist-info/RECORD

@@ -0,0 +1,12 @@
+shepherd_data/__init__.py,sha256=EZ_RzvcBkL2fMTCCWtKcbzMcrmmwgDb7SD-GZhvqUnA,243
+shepherd_data/cli.py,sha256=2GDpTgd9cHJQS-GZJSvn2bhyeh6oG_srtITfc3FGAmg,15017
+shepherd_data/debug_resampler.py,sha256=0VNGuUqOeKii6fvkRJUpv-27uv9p1VFsvShU3tvxwYQ,961
+shepherd_data/ivonne.py,sha256=ArojlpWWYwaetkDtBhi-RdFidt79GHoMLZLRR6KljRo,11600
+shepherd_data/mppt.py,sha256=588KSrLuJfNRKKnnL6ewePLi3zrwaO_PAZypikACrks,3925
+shepherd_data/reader.py,sha256=JKTVemjH_6678MCNf2cDzRIsCyfD2B6CTUzBiG110QY,18531
+shepherd_data-2024.4.1.dist-info/METADATA,sha256=ZuZcImaE9O7tvzyibfM4wVcToX_p7nImzS4lq8DEUoA,3388
+shepherd_data-2024.4.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+shepherd_data-2024.4.1.dist-info/entry_points.txt,sha256=6PBfY36A1xNOdzLiz-Qoukya_UzFZAwOapwmRNnPeZ8,56
+shepherd_data-2024.4.1.dist-info/top_level.txt,sha256=7-SCTY-TG1mLY72OVKCaqte1hy-X8woxknIUAD3OIxs,14
+shepherd_data-2024.4.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+shepherd_data-2024.4.1.dist-info/RECORD,,

{shepherd_data-2023.11.1.dist-info → shepherd_data-2024.4.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.3)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{shepherd_data-2023.11.1.dist-info → shepherd_data-2024.4.1.dist-info}/top_level.txt

@@ -1,2 +1 @@
 shepherd_data
-tests

shepherd_data-2023.11.1.dist-info/METADATA

@@ -1,274 +0,0 @@
-Metadata-Version: 2.1
-Name: shepherd-data
-Version: 2023.11.1
-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
-Author-email: ingmar.splitt@tu-dresden.de
-Maintainer-email: ingmar.splitt@tu-dresden.de
-License: MIT
-Project-URL: Tracker, https://github.com/orgua/shepherd-datalib/issues
-Project-URL: Source, https://github.com/orgua/shepherd-datalib
-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: h5py
-Requires-Dist: numpy
-Requires-Dist: pyYAML
-Requires-Dist: shepherd-core[inventory] >=2023.11.1
-Requires-Dist: click
-Requires-Dist: matplotlib
-Requires-Dist: pandas
-Requires-Dist: scipy
-Requires-Dist: tqdm
-Provides-Extra: dev
-Requires-Dist: shepherd-core[dev] ; extra == 'dev'
-Requires-Dist: pandas-stubs ; extra == 'dev'
-Provides-Extra: elf
-Requires-Dist: shepherd-core[elf] ; extra == 'elf'
-Provides-Extra: test
-Requires-Dist: shepherd-core[test] ; extra == 'test'
-Requires-Dist: pytest-click ; extra == 'test'
-
-# Data Module
-
-[![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/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-
-**Documentation**: <https://orgua.github.io/shepherd/external/shepherd_data.html>
-
-**Source Code**: <https://github.com/orgua/shepherd-datalib>
-
-**Main Project**: <https://github.com/orgua/shepherd>
-
----
-
-This Python Module 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
-```
-
-## Programming Interface
-
-### Basic Usage (recommendation)
-
-```python
-import shepherd_data as sd
-
-with sd.Reader("./hrv_sawtooth_1h.h5") as db:
-    print(f"Mode: {db.get_mode()}")
-    print(f"Window: {db.get_window_samples()}")
-    print(f"Config: {db.get_config()}")
-```
-
-### Available Functionality
-
-- `Reader()`
-  - file can be checked for plausibility and validity (`is_valid()`)
-  - internal structure of h5file (`get_metadata()` or `save_metadata()` ... to yaml) with lots of additional data
-  - access data and various converters, calculators
-    - `read_buffers()` -> generator that provides one buffer per call, can be configured on first call
-    - `get_calibration_data()`
-    - `get_windows_samples()`
-    - `get_mode()`
-    - `get_config()`
-    - direct access to root h5-structure via `reader['element']`
-    - converters for raw / physical units: `si_to_raw()` & `raw_to_si()`
-    - `energy()` sums up recorded power over time
-  - `downsample()` (if needed) visualize recording (`plot_to_file()`)
-- `Writer()`
-  - inherits all functionality from Reader
-  - `append_iv_data_raw()`
-  - `append_iv_data_si()`
-  - `set_config()`
-  - `set_windows_samples()`
-- IVonne Reader
-  - `convert_2_ivcurves()` converts ivonne-recording into a shepherd ivcurve
-  - `upsample_2_isc_voc()` TODO: for now a upsampled but unusable version of samples of short-circuit-current and open-circuit-voltage
-  - `convert_2_ivsamples()` already applies a simple harvesting-algo and creates ivsamples
-- `./examples/`
-  - `example_convert_ivonne.py` converts IVonne recording (`jogging_10m.iv`) to shepherd ivcurves, NOTE: slow implementation
-  - `example_extract_logs.py` is analyzing all files in directory, saves logging-data and calculates cpu-load and data-rate
-  - `example_generate_sawtooth.py` is using Writer to generate a 60s ramp with 1h repetition and uses Reader to dump metadata of that file
-  - `example_plot_traces.py` demos some mpl-plots with various zoom levels
-  - `example_repair_recordings.py` makes old recordings from shepherd 1.x fit for v2
-  - `jogging_10m.iv`
-      - 50 Hz measurement with Short-Circuit-Current and two other parameters
-      - recorded with "IVonne"
-
-### Functionality Update (WIP)
-
-- Core.`Reader`
-  - `__repr__()`
-  - `read_buffers`
-  - `get_calibration_data`
-  - `get_window_samples`
-  - `get_mode`
-  - `get_config`
-  - `get_hostname`
-  - `get_datatype`
-  - `get_hrv_config`
-  - `is_valid`
-  - `energy()`
-  - `check_timediffs()`
-  - `get_metadata()`
-  - `save_metadata()`
-
-- `Writer(Reader)` (core, data are the same)
-  - `append_iv_data_raw`
-  - `append_iv_data_si`
-  - `store_config`
-  - `store_hostname`
-
-- data.`Reader(CoreReader)`
-  - `save_csv()`
-  - `save_log()`
-  - `downsample()`
-  - `resample()`
-  - `generate_plot_data()`
-  - `assemble_plot()`
-  - `plot_to_file()`
-  - `multiplot_to_file()`
-
-## CLI-Interface
-
-After installing the module the datalib offers some often needed functionality on the command line:
-
-**Validate Recordings**
-
-- takes a file or directory as an argument
-
-```shell
-shepherd-data validate dir_or_file
-
-# examples:
-shepherd-data validate ./
-shepherd-data validate hrv_saw_1h.h5
-```
-
-**Extract IV-Samples to csv**
-
-- takes a file or directory as an argument
-- can take down-sample-factor as an argument
-
-```shell
-shepherd-data extract [-f ds-factor] [-s separator_symbol] dir_or_file
-
-# examples:
-shepherd-data extract ./
-shepherd-data extract -f 1000 -s ; hrv_saw_1h.h5
-```
-
-**Extract meta-data and sys-logs**
-
-- takes a file or directory as an argument
-
-```shell
-shepherd-data extract-meta dir_or_file
-
-# examples:
-shepherd-data extract-meta ./
-shepherd-data extract-meta hrv_saw_1h.h5
-```
-
-**Plot IVSamples**
-
-- takes a file or directory as an argument
-- can take start- and end-time as an argument
-- can take image-width and -height as an argument
-
-```shell
-shepherd-data plot [-s start_time] [-e end_time] [-w plot_width] [-h plot_height] [--multiplot] dir_or_file
-
-# examples:
-shepherd-data plot --multiplot ./
-shepherd-data plot -s10 -e20 hrv_saw_1h.h5
-```
-
-**Downsample IVSamples (for later GUI-usage, TODO)**
-
-- generates a set of downsamplings (20 kHz to 0.1 Hz in x4 to x5 Steps)
-- takes a file or directory as an argument
-- can take down-sample-factor as an argument
-
-```shell
-shepherd-data downsample [-f ds-factor] [-r sample-rate] dir_or_file
-
-# examples:
-shepherd-data downsample ./
-shepherd-data downsample -f 1000 hrv_saw_1h.h5
-shepherd-data downsample -r 100 hrv_saw_1h.h5
-```
-
-## Data-Layout and Design choices
-
-Details about the file-structure can be found in the [main-project](https://github.com/orgua/shepherd/blob/main/docs/user/data_format.rst).
-
-TODO:
-- update design of file
-- data dtype, mode, ...
-
-### Modes and Datatypes
-
-- Mode `harvester` recorded a harvesting-source like solar with one of various algorithms
-  - Datatype `ivsample` is directly usable by shepherd, input for virtual source / converter
-  - Datatype `ivcurve` is directly usable by shepherd, input for a virtual harvester (output are ivsamples)
-  - Datatype `isc_voc` is specially for solar-cells and needs to be (at least) transformed into ivcurves later
-- Mode `emulator` replayed a harvester-recording through a virtual converter and supplied a target while recording the power-consumption
-  - Datatype `ivsample` is the only output of this mode
-
-### Compression & Beaglebone
-
-- supported are uncompressed, lzf and gzip with level 1 (order of recommendation)
-  - lzf seems better-suited due to lower load, or if space isn't a constraint: uncompressed (None as argument)
-  - note: lzf seems to cause trouble with some third party hdf5-tools
-  - compression is a heavy load for the beaglebone, but it got more performant with recent python-versions
-- size-experiment A: 24 h of ramping / sawtooth (data is repetitive with 1 minute ramp)
-  - gzip-1: 49'646 MiB -> 588 KiB/s
-  - lzf: 106'445 MiB -> 1262 KiB/s
-  - uncompressed: 131'928 MiB -> 1564 KiB/s
-- cpu-load-experiments (input is 24h sawtooth, python 3.10 with most recent libs as of 2022-04)
-  - warning: gpio-traffic and other logging-data can cause lots of load
-
-```
-  emu_120s_gz1_to_gz1.h5 	-> emulator, cpu_util [%] = 65.59, data-rate =  352.0 KiB/s
-  emu_120s_gz1_to_lzf.h5 	-> emulator, cpu_util [%] = 57.37, data-rate =  686.0 KiB/s
-  emu_120s_gz1_to_unc.h5 	-> emulator, cpu_util [%] = 53.63, data-rate = 1564.0 KiB/s
-  emu_120s_lzf_to_gz1.h5 	-> emulator, cpu_util [%] = 63.18, data-rate =  352.0 KiB/s
-  emu_120s_lzf_to_lzf.h5 	-> emulator, cpu_util [%] = 58.60, data-rate =  686.0 KiB/s
-  emu_120s_lzf_to_unc.h5 	-> emulator, cpu_util [%] = 55.75, data-rate = 1564.0 KiB/s
-  emu_120s_unc_to_gz1.h5 	-> emulator, cpu_util [%] = 63.84, data-rate =  351.0 KiB/s
-  emu_120s_unc_to_lzf.h5 	-> emulator, cpu_util [%] = 57.28, data-rate =  686.0 KiB/s
-  emu_120s_unc_to_unc.h5 	-> emulator, cpu_util [%] = 51.69, data-rate = 1564.0 KiB/s
-```

shepherd_data-2023.11.1.dist-info/RECORD

@@ -1,22 +0,0 @@
-shepherd_data/__init__.py,sha256=Ys41EYMRuO_55OepmLO6icu4xKGX9I9QJowHWa9jzuo,242
-shepherd_data/cli.py,sha256=u9ImWh-VLVlk1-TJaQs7govRHoiiuF5xIeOCLBzr8k8,15341
-shepherd_data/debug_resampler.py,sha256=Y4uxSXqWKoyyJ1H6TY1vZKe0pWMK_mjQY0xBr7dC_f4,983
-shepherd_data/ivonne.py,sha256=ZGCjctOFYJyMH9AsiF8oaFd_QuvVDbGdPuj3qoICHYg,12017
-shepherd_data/mppt.py,sha256=YWMw3lhReHbjmK1LVgrIo2S_SoBmIXI4a_sqUpHMuGE,3640
-shepherd_data/reader.py,sha256=toX3NLqmifUYfrSp81XrmDJkWm8jdhwUIWy8v530tRI,18440
-tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/conftest.py,sha256=BCtm2TbfVf85_AsGOUZLXd6TquicWRMgBq2-q5UA2UM,985
-tests/test_cli.py,sha256=PPbRwgOQbWjNcgR7mIXTnGdboCQ4QDC4Kh74kSaEFhc,181
-tests/test_cli_downsample.py,sha256=dsI04rJrFdNl50uW5DplmA4Uh1S2Y2hCYq-HkM47pG8,1803
-tests/test_cli_extract.py,sha256=XhXNNyiRRuXkDqkgWLaFTZkge6tv2a8jJyAd2zt8QlE,2532
-tests/test_cli_plot.py,sha256=IaN1Z37XYgfkxSzJkfej8Vp9FqSUeYCSog3ratnDePQ,3298
-tests/test_cli_validate.py,sha256=DOfaRq6r05eu8x4SnZOPrPfbbMNu0PTus7lSV8Gkzwo,405
-tests/test_examples.py,sha256=e_uc5h_I4wwJnIWuh-PjpSSTICkYemI831iqhxIy_R0,576
-tests/test_ivonne.py,sha256=cIMtpx7tjRFxL9hpr5OPPgroGLzRZxGC4x9Y7vWgze8,1367
-tests/test_reader.py,sha256=Xt__Khgldv8klZJ3OQcMZevC6_3gPH2_TpOorq2ytNI,90
-shepherd_data-2023.11.1.dist-info/METADATA,sha256=a0Jd5FvKexcOLiRcc46seLGm6vut-kcAHiwyWC2N-3U,9942
-shepherd_data-2023.11.1.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
-shepherd_data-2023.11.1.dist-info/entry_points.txt,sha256=6PBfY36A1xNOdzLiz-Qoukya_UzFZAwOapwmRNnPeZ8,56
-shepherd_data-2023.11.1.dist-info/top_level.txt,sha256=Bk61YO7iYS43TSWtwdSKb2moGBvJqJIYfGaZsQsv09M,20
-shepherd_data-2023.11.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-shepherd_data-2023.11.1.dist-info/RECORD,,