shepherd-data 2024.7.3__py3-none-any.whl → 2024.7.4__py3-none-any.whl

shepherd_data/__init__.py

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

shepherd_data/cli.py

@@ -58,7 +58,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:  # noqa: FBT001
+def cli(ctx: click.Context, *, verbose: bool, version: bool) -> None:
     """Shepherd: Synchronized Energy Harvesting Emulator and Recorder."""
     if verbose:
         increase_verbose_level(3)
@@ -355,13 +355,21 @@ def downsample(in_data: Path, ds_factor: Optional[float], sample_rate: Optional[
     is_flag=True,
     help="Plot all files (in directory) into one Multiplot",
 )
+@click.option(
+    "--only-power",
+    "-p",
+    is_flag=True,
+    help="Plot only power instead of voltage, current & power",
+)
 def plot(
     in_data: Path,
     start: Optional[float],
     end: Optional[float],
     width: int,
     height: int,
-    multiplot: bool,  # noqa: FBT001
+    *,
+    multiplot: bool,
+    only_power: bool,
 ) -> None:
     """Plot IV-trace from file or directory containing shepherd-recordings."""
     files = path_to_flist(in_data)
@@ -378,12 +386,12 @@ def plot(
                         continue
                     data.append(date)
                 else:
-                    shpr.plot_to_file(start, end, width, height)
+                    shpr.plot_to_file(start, end, width, height, only_pwr=only_power)
         except TypeError:
             logger.exception("ERROR: Will skip file. It caused an exception.")
     if multiplot:
         logger.info("Got %d datasets to plot", len(data))
-        mpl_path = Reader.multiplot_to_file(data, in_data, width, height)
+        mpl_path = Reader.multiplot_to_file(data, in_data, width, height, only_pwr=only_power)
         if mpl_path:
             logger.info("Plot generated and saved to '%s'", mpl_path.name)
         else:

shepherd_data/reader.py

@@ -171,7 +171,6 @@ 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)):
@@ -345,7 +344,6 @@ class Reader(CoreReader):
         """
         if self.get_datatype() == "ivcurve":
             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)):
@@ -357,7 +355,7 @@ class Reader(CoreReader):
             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 = {
+        data: dict = {
             "name": self.get_hostname(),
             "time": self._cal.time.raw_to_si(
                 self.downsample(
@@ -383,28 +381,49 @@ class Reader(CoreReader):
         return data
 
     @staticmethod
-    def assemble_plot(data: Union[dict, list], width: int = 20, height: int = 10) -> plt.Figure:
+    def assemble_plot(
+        data: Union[dict, list], width: int = 20, height: int = 10, *, only_pwr: bool = False
+    ) -> plt.Figure:
         """Create the actual figure.
 
+        Due to the 50 mA limits of the cape the default units for current & power are mA & mW.
+
         :param data: plottable / down-sampled iv-data with some meta-data
                 -> created with generate_plot_data()
         :param width: plot-width
         :param height: plot-height
+        :param only_pwr: plot power-trace instead of voltage, current & power
         :return: figure
         """
-        # TODO: add power (if wanted)
+        # TODO: allow choosing freely from I, V, P, GPIO
         if isinstance(data, dict):
             data = [data]
-        fig, axes = plt.subplots(2, 1, sharex="all")
-        fig.suptitle("Voltage and current")
-        for date in data:
-            axes[0].plot(date["time"], date["voltage"], label=date["name"])
-            axes[1].plot(date["time"], date["current"] * 10**6, label=date["name"])
-        axes[0].set_ylabel("voltage [V]")
-        axes[1].set_ylabel(r"current [$\mu$A]")
-        if len(data) > 1:
-            axes[0].legend(loc="lower center", ncol=len(data))
-        axes[1].set_xlabel("time [s]")
+        if only_pwr:
+            fig = plt.figure(figsize=(width, height))
+            fig.suptitle("Power-Trace")
+            plt.xlabel("time [s]")
+            plt.ylabel("power [mW]")
+            for date in data:
+                plt.plot(
+                    date["time"], date["voltage"] * date["current"] * 10**3, label=date["name"]
+                )
+            if len(data) > 1:
+                plt.legend(loc="lower center", ncol=len(data))
+        else:
+            fig, axes = plt.subplots(3, 1, sharex="all")
+            fig.suptitle("Voltage, current & power")
+            for date in data:
+                axes[0].plot(date["time"], date["voltage"], label=date["name"])
+                axes[1].plot(date["time"], date["current"] * 10**3, label=date["name"])
+                axes[2].plot(
+                    date["time"], date["voltage"] * date["current"] * 10**3, label=date["name"]
+                )
+            axes[0].set_ylabel("voltage [V]")
+            axes[1].set_ylabel("current [mA]")
+            axes[2].set_ylabel("power [mW]")
+            if len(data) > 1:
+                axes[0].legend(loc="lower center", ncol=len(data))
+            axes[2].set_xlabel("time [s]")
         fig.set_figwidth(width)
         fig.set_figheight(height)
         fig.tight_layout()
@@ -416,6 +435,8 @@ class Reader(CoreReader):
         end_s: Optional[float] = None,
         width: int = 20,
         height: int = 10,
+        *,
+        only_pwr: bool = False,
     ) -> None:
         """Create (down-sampled) IV-Plots.
 
@@ -425,6 +446,7 @@ class Reader(CoreReader):
         :param end_s: time in seconds, relative to start of recording, optional
         :param width: plot-width
         :param height: plot-height
+        :param only_pwr: plot power-trace instead of voltage, current & power
         """
         if not isinstance(self.file_path, Path):
             return
@@ -440,14 +462,19 @@ class Reader(CoreReader):
             self._logger.warning("Plot exists, will skip & not overwrite!")
             return
         self._logger.info("Plot generated, will be saved to '%s'", plot_path.name)
-        fig = self.assemble_plot(data, width, height)
+        fig = self.assemble_plot(data, width, height, only_pwr=only_pwr)
         plt.savefig(plot_path)
         plt.close(fig)
         plt.clf()
 
     @staticmethod
     def multiplot_to_file(
-        data: list, plot_path: Path, width: int = 20, height: int = 10
+        data: list,
+        plot_path: Path,
+        width: int = 20,
+        height: int = 10,
+        *,
+        only_pwr: bool = False,
     ) -> Optional[Path]:
         """Create (down-sampled) IV-Multi-Plots (of more than one trace).
 
@@ -456,6 +483,7 @@ class Reader(CoreReader):
         :param plot_path: optional
         :param width: plot-width
         :param height: plot-height
+        :param only_pwr: plot power-trace instead of voltage, current & power
         """
         start_str = f"{data[0]['start_s']:.3f}".replace(".", "s")
         end_str = f"{data[0]['end_s']:.3f}".replace(".", "s")
@@ -465,7 +493,7 @@ class Reader(CoreReader):
         if plot_path.exists():
             logger.warning("Plot exists, will skip & not overwrite!")
             return None
-        fig = Reader.assemble_plot(data, width, height)
+        fig = Reader.assemble_plot(data, width, height, only_pwr=only_pwr)
         plt.savefig(plot_path)
         plt.close(fig)
         plt.clf()

{shepherd_data-2024.7.3.dist-info → shepherd_data-2024.7.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shepherd_data
-Version: 2024.7.3
+Version: 2024.7.4
 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.3
+Requires-Dist: shepherd-core[inventory] >=2024.7.4
 Requires-Dist: tqdm
 Provides-Extra: dev
 Requires-Dist: shepherd-core[dev] ; extra == 'dev'

shepherd_data-2024.7.4.dist-info/RECORD

@@ -0,0 +1,11 @@
+shepherd_data/__init__.py,sha256=6-KKBydEEYJAB_sME8Lu0_GfyUchSr5W6p4TcLaM6so,352
+shepherd_data/cli.py,sha256=pv17ILFQCdPSyWgmw0rQIhdsYucqeiWFwJn8hft4ga0,15760
+shepherd_data/ivonne.py,sha256=5EryExMQ8E8PTgX5xkZUyLqhvhCcLT17rdC0POv4NLI,11831
+shepherd_data/mppt.py,sha256=588KSrLuJfNRKKnnL6ewePLi3zrwaO_PAZypikACrks,3925
+shepherd_data/reader.py,sha256=l9Kcx1YHqkd_ef_QRTNpWE5ZEmxPeiVkOPw680Klzkk,20186
+shepherd_data-2024.7.4.dist-info/METADATA,sha256=ZkPJrT_VxcNqVo7baBOx1cSlk9KzswnzSIFg-4tc4Rk,3387
+shepherd_data-2024.7.4.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+shepherd_data-2024.7.4.dist-info/entry_points.txt,sha256=6PBfY36A1xNOdzLiz-Qoukya_UzFZAwOapwmRNnPeZ8,56
+shepherd_data-2024.7.4.dist-info/top_level.txt,sha256=7-SCTY-TG1mLY72OVKCaqte1hy-X8woxknIUAD3OIxs,14
+shepherd_data-2024.7.4.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+shepherd_data-2024.7.4.dist-info/RECORD,,

{shepherd_data-2024.7.3.dist-info → shepherd_data-2024.7.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.3.0)
+Generator: setuptools (72.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

shepherd_data-2024.7.3.dist-info/RECORD

@@ -1,11 +0,0 @@
-shepherd_data/__init__.py,sha256=w0ul7JHLugSUkft5dURi3zowh6Qc7_1Yzu_PNmmcVgo,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.3.dist-info/METADATA,sha256=polL3ZZTD2NccYOBAXg6IxhkJs5jui86_JRMJpcXvsk,3387
-shepherd_data-2024.7.3.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
-shepherd_data-2024.7.3.dist-info/entry_points.txt,sha256=6PBfY36A1xNOdzLiz-Qoukya_UzFZAwOapwmRNnPeZ8,56
-shepherd_data-2024.7.3.dist-info/top_level.txt,sha256=7-SCTY-TG1mLY72OVKCaqte1hy-X8woxknIUAD3OIxs,14
-shepherd_data-2024.7.3.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-shepherd_data-2024.7.3.dist-info/RECORD,,