shepherd-data 2024.7.1__py3-none-any.whl → 2024.7.2__py3-none-any.whl

shepherd_data/__init__.py

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

shepherd_data/cli.py

@@ -119,6 +119,14 @@ def extract(in_data: Path, ds_factor: float, separator: str) -> None:
         logger.info("Extracting IV-Samples from '%s' ...", file.name)
         try:
             with Reader(file, verbose=verbose_level > 2) as shpr:
+                # TODO: this code is very similar to data.reader.downsample()
+                if (shpr.ds_voltage.shape[0] / ds_factor) < 10:
+                    logger.warning(
+                        "will skip downsampling for %s because "
+                        "resulting sample-size is too small",
+                        file.name,
+                    )
+                    continue
                 # 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():
@@ -203,6 +211,8 @@ def extract_uart(in_data: Path) -> None:
             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()
+                if lines is None:
+                    continue
                 # 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():
@@ -280,7 +290,7 @@ def downsample(in_data: Path, ds_factor: Optional[float], sample_rate: Optional[
         try:
             with Reader(file, verbose=verbose_level > 2) as shpr:
                 for _factor in ds_list:
-                    if shpr.ds_voltage.shape[0] / _factor < 1000:
+                    if (shpr.ds_voltage.shape[0] / _factor) < 1000:
                         logger.warning(
                             "will skip downsampling for %s because "
                             "resulting sample-size is too small",
@@ -363,7 +373,10 @@ def plot(
         try:
             with Reader(file, verbose=verbose_level > 2) as shpr:
                 if multiplot:
-                    data.append(shpr.generate_plot_data(start, end, relative_timestamp=True))
+                    date = shpr.generate_plot_data(start, end, relative_timestamp=True)
+                    if date is None:
+                        continue
+                    data.append(date)
                 else:
                     shpr.plot_to_file(start, end, width, height)
         except TypeError:

shepherd_data/reader.py

@@ -44,7 +44,7 @@ class Reader(CoreReader):
         :param separator: used between columns
         :return: number of processed entries
         """
-        if h5_group["time"].shape[0] < 1:
+        if ("time" not in h5_group) or (h5_group["time"].shape[0] < 1):
             self._logger.warning("%s is empty, no csv generated", h5_group.name)
             return 0
         if not isinstance(self.file_path, Path):
@@ -80,7 +80,7 @@ class Reader(CoreReader):
         :param add_timestamp: can be external
         :return: number of processed entries
         """
-        if h5_group["time"].shape[0] < 1:
+        if ("time" not in h5_group) or (h5_group["time"].shape[0] < 1):
             self._logger.warning("%s is empty, no log generated", h5_group.name)
             return 0
         if not isinstance(self.file_path, Path):
@@ -117,7 +117,7 @@ class Reader(CoreReader):
     ) -> int:
         """Print warning messages from log in data-group."""
         _count = self.count_errors_in_log(group_name, min_level)
-        if _count < 1:
+        if (_count < 1) or ("level" not in self.h5file[group_name]):
             return 0
         if not show:
             return _count
@@ -154,7 +154,7 @@ class Reader(CoreReader):
         ds_factor: float = 5,
         *,
         is_time: bool = False,
-    ) -> Union[h5py.Dataset, np.ndarray]:
+    ) -> Union[None, h5py.Dataset, np.ndarray]:
         """Sample down iv-data.
 
         Warning: only valid for IV-Stream, not IV-Curves
@@ -171,6 +171,7 @@ class Reader(CoreReader):
 
         if self.get_datatype() == "ivcurve":
             self._logger.warning("Downsampling-Function was not written for IVCurves")
+            return data_dst
         ds_factor = max(1, math.floor(ds_factor))
 
         if isinstance(end_n, (int, float)):
@@ -182,6 +183,7 @@ class Reader(CoreReader):
         data_len = _end_n - start_n  # TODO: one-off to calculation below ?
         if data_len == 0:
             self._logger.warning("downsampling failed because of data_len = 0")
+            return data_dst
         iblock_len = min(self.max_elements, data_len)
         oblock_len = round(iblock_len / ds_factor)
         iterations = math.ceil(data_len / iblock_len)
@@ -233,7 +235,7 @@ class Reader(CoreReader):
         samplerate_dst: float = 1000,
         *,
         is_time: bool = False,
-    ) -> Union[h5py.Dataset, np.ndarray]:
+    ) -> Union[None, h5py.Dataset, np.ndarray]:
         """Up- or down-sample the original trace-data.
 
         :param data_src: original iv-data
@@ -247,7 +249,7 @@ class Reader(CoreReader):
         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")
-
+            return data_dst
         if isinstance(end_n, (int, float)):
             _end_n = min(data_src.shape[0], round(end_n))
         else:
@@ -257,11 +259,12 @@ class Reader(CoreReader):
         data_len = _end_n - start_n
         if data_len == 0:
             self._logger.warning("resampling failed because of data_len = 0")
+            return data_dst
         fs_ratio = samplerate_dst / self.samplerate_sps
         dest_len = math.floor(data_len * fs_ratio) + 1
         if fs_ratio <= 1.0:  # down-sampling
             slice_inp_len = min(self.max_elements, data_len)
-            slice_out_len = round(slice_inp_len * fs_ratio)
+            slice_out_len = round(slice_inp_len * fs_ratio)  # TODO: is that correct?
         else:  # up-sampling
             slice_out_len = min(self.max_elements, data_len * fs_ratio)
             slice_inp_len = round(slice_out_len / fs_ratio)
@@ -332,7 +335,7 @@ class Reader(CoreReader):
         end_s: Optional[float] = None,
         *,
         relative_timestamp: bool = True,
-    ) -> Dict:
+    ) -> Optional[Dict]:
         """Provide down-sampled iv-data that can be fed into plot_to_file().
 
         :param start_s: time in seconds, relative to start of recording
@@ -341,13 +344,17 @@ class Reader(CoreReader):
         :return: down-sampled size of ~ self.max_elements
         """
         if self.get_datatype() == "ivcurve":
-            self._logger.warning("Plot-Function was not written for IVCurves")
+            self._logger.warning("Plot-Function was not written for IVCurves.")
+            return None
         if not isinstance(start_s, (float, int)):
             start_s = 0
         if not isinstance(end_s, (float, int)):
             end_s = self.runtime_s
         start_sample = round(start_s * self.samplerate_sps)
         end_sample = round(end_s * self.samplerate_sps)
+        if end_sample - start_sample < 5:
+            self._logger.warning("Skip plot, because of small sample-size.")
+            return None
         samplerate_dst = max(round(self.max_elements / (end_s - start_s), 3), 0.001)
         ds_factor = float(self.samplerate_sps / samplerate_dst)
         data = {
@@ -422,10 +429,12 @@ class Reader(CoreReader):
         if not isinstance(self.file_path, Path):
             return
 
-        data = [self.generate_plot_data(start_s, end_s)]
+        data = self.generate_plot_data(start_s, end_s)
+        if data is None:
+            return
 
-        start_str = f"{data[0]['start_s']:.3f}".replace(".", "s")
-        end_str = f"{data[0]['end_s']:.3f}".replace(".", "s")
+        start_str = f"{data['start_s']:.3f}".replace(".", "s")
+        end_str = f"{data['end_s']:.3f}".replace(".", "s")
         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!")

{shepherd_data-2024.7.1.dist-info → shepherd_data-2024.7.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shepherd_data
-Version: 2024.7.1
+Version: 2024.7.2
 Summary: Programming- and CLI-Interface for the h5-dataformat of the Shepherd-Testbed
 Author-email: Ingmar Splitt <ingmar.splitt@tu-dresden.de>
 Maintainer-email: Ingmar Splitt <ingmar.splitt@tu-dresden.de>
@@ -35,7 +35,7 @@ Requires-Dist: numpy
 Requires-Dist: pandas >=2.0.0
 Requires-Dist: pyYAML
 Requires-Dist: scipy
-Requires-Dist: shepherd-core[inventory] >=2024.7.1
+Requires-Dist: shepherd-core[inventory] >=2024.7.2
 Requires-Dist: tqdm
 Provides-Extra: dev
 Requires-Dist: shepherd-core[dev] ; extra == 'dev'

shepherd_data-2024.7.2.dist-info/RECORD

@@ -0,0 +1,11 @@
+shepherd_data/__init__.py,sha256=kbHJcBM_nHRN51web7bn50DBWak8vV1VqEK7KYeW9mQ,352
+shepherd_data/cli.py,sha256=p_SS_LRn6PxvIJRqpubCWM-qw2GCsn24evrdCCtynfY,15589
+shepherd_data/ivonne.py,sha256=5EryExMQ8E8PTgX5xkZUyLqhvhCcLT17rdC0POv4NLI,11831
+shepherd_data/mppt.py,sha256=588KSrLuJfNRKKnnL6ewePLi3zrwaO_PAZypikACrks,3925
+shepherd_data/reader.py,sha256=Sh33PlaafGGXVr8n2I7pM-b-vmkxYhJALsmBfpUbvHc,19000
+shepherd_data-2024.7.2.dist-info/METADATA,sha256=Z6AFosmQiXEkdM-845BApEiFQXnbM7EHTAgotoTLC1U,3387
+shepherd_data-2024.7.2.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
+shepherd_data-2024.7.2.dist-info/entry_points.txt,sha256=6PBfY36A1xNOdzLiz-Qoukya_UzFZAwOapwmRNnPeZ8,56
+shepherd_data-2024.7.2.dist-info/top_level.txt,sha256=7-SCTY-TG1mLY72OVKCaqte1hy-X8woxknIUAD3OIxs,14
+shepherd_data-2024.7.2.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+shepherd_data-2024.7.2.dist-info/RECORD,,

shepherd_data-2024.7.1.dist-info/RECORD

@@ -1,11 +0,0 @@
-shepherd_data/__init__.py,sha256=D-QyEhYdKu0NrfxtHZmRg71QC6jFOoIsLJRiGSO2Ufg,352
-shepherd_data/cli.py,sha256=21BzQMhPfHocpExmXb8BXTk58zZzc4Up7tLzjpyFwjI,15031
-shepherd_data/ivonne.py,sha256=5EryExMQ8E8PTgX5xkZUyLqhvhCcLT17rdC0POv4NLI,11831
-shepherd_data/mppt.py,sha256=588KSrLuJfNRKKnnL6ewePLi3zrwaO_PAZypikACrks,3925
-shepherd_data/reader.py,sha256=JKTVemjH_6678MCNf2cDzRIsCyfD2B6CTUzBiG110QY,18531
-shepherd_data-2024.7.1.dist-info/METADATA,sha256=RSM7L3RAj0zCeM9kX0X3KIz2KWgh3y4ZF2IaZordgtI,3387
-shepherd_data-2024.7.1.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
-shepherd_data-2024.7.1.dist-info/entry_points.txt,sha256=6PBfY36A1xNOdzLiz-Qoukya_UzFZAwOapwmRNnPeZ8,56
-shepherd_data-2024.7.1.dist-info/top_level.txt,sha256=7-SCTY-TG1mLY72OVKCaqte1hy-X8woxknIUAD3OIxs,14
-shepherd_data-2024.7.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-shepherd_data-2024.7.1.dist-info/RECORD,,