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

shepherd_data-2024.4.2/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.1
+Name: shepherd_data
+Version: 2024.4.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>
+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.4.2
+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.2/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.2/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.4.2",
+    "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.2/setup.cfg

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

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

@@ -1,14 +1,17 @@
-"""shepherd.datalib
-~~~~~
-Provides classes for storing and retrieving sampled IV data to/from
-HDF5 files.
+"""Provides higher functionality compared to core, with additional lib-requirements.
 
+Provides classes for storing and retrieving sampled IV data to/from
+HDF5 files, with
+- resampling
+- plotting
+- extracting metadata
 """
+
 from shepherd_core import Writer
 
 from .reader import Reader
 
-__version__ = "2023.12.1"
+__version__ = "2024.4.2"
 
 __all__ = [
     "Reader",

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

@@ -1,5 +1,5 @@
-"""Command definitions for CLI
-"""
+"""Command definitions for CLI."""
+
 import logging
 import os
 import sys
@@ -16,15 +16,17 @@ from shepherd_core import increase_verbose_level
 from shepherd_core import local_tz
 from shepherd_core.commons import samplerate_sps_default
 
-from . import Reader
 from . import Writer
 from . import __version__
+from .reader import Reader
 
 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.
+
+    Transformations:
     - if directory: list of files inside
     - if existing file: list with 1 element
     - or else: empty list
@@ -57,7 +59,7 @@ def path_to_flist(data_path: Path) -> List[Path]:
 )
 @click.pass_context  # TODO: is the ctx-type correct?
 def cli(ctx: click.Context, verbose: bool, version: bool) -> None:  # noqa: FBT001
-    """Shepherd: Synchronized Energy Harvesting Emulator and Recorder"""
+    """Shepherd: Synchronized Energy Harvesting Emulator and Recorder."""
     if verbose:
         increase_verbose_level(3)
     if version:
@@ -71,7 +73,7 @@ def cli(ctx: click.Context, verbose: bool, version: bool) -> None:  # noqa: FBT0
 @cli.command(short_help="Validates a file or directory containing shepherd-recordings")
 @click.argument("in_data", type=click.Path(exists=True, resolve_path=True))
 def validate(in_data: Path) -> None:
-    """Validates a file or directory containing shepherd-recordings"""
+    """Validate a file or directory containing shepherd-recordings."""
     files = path_to_flist(in_data)
     verbose_level = get_verbose_level()  # TODO: should be stored and passed in ctx
     valid_dir = True
@@ -85,8 +87,8 @@ def validate(in_data: Path) -> None:
                 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)
+        except TypeError:
+            logger.exception("ERROR: Will skip file. It caused an exception.")
     sys.exit(int(not valid_dir))
 
 
@@ -107,7 +109,7 @@ def validate(in_data: Path) -> None:
     help="Set an individual csv-separator",
 )
 def extract(in_data: Path, ds_factor: float, separator: str) -> None:
-    """Extracts recorded IVSamples and stores it to csv"""
+    """Extract recorded IVSamples and store them to csv."""
     files = path_to_flist(in_data)
     verbose_level = get_verbose_level()
     if not isinstance(ds_factor, (float, int)) or ds_factor < 1:
@@ -143,8 +145,8 @@ def extract(in_data: Path, ds_factor: float, separator: str) -> None:
 
                 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)
+        except TypeError:
+            logger.exception("ERROR: Will skip file. It caused an exception.")
 
 
 @cli.command(
@@ -159,14 +161,14 @@ def extract(in_data: Path, ds_factor: float, separator: str) -> None:
     help="Set an individual csv-separator",
 )
 def extract_meta(in_data: Path, separator: str) -> None:
-    """Extracts metadata and logs from file or directory containing shepherd-recordings"""
+    """Extract metadata and logs from file or directory containing shepherd-recordings."""
     files = path_to_flist(in_data)
     verbose_level = get_verbose_level()
     for file in files:
         logger.info("Extracting metadata & logs from '%s' ...", file.name)
         # 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"
+        # TODO: remove deprecated timesync; "shepherd-log", "dmesg", "exceptions"
         try:
             with Reader(file, verbose=verbose_level > 2) as shpr:
                 shpr.save_metadata()
@@ -181,8 +183,8 @@ def extract_meta(in_data: Path, separator: str) -> None:
                         # TODO: allow omitting timestamp,
                         #       also test if segmented uart is correctly written
                         shpr.warn_logs(element, show=True)
-        except TypeError as _xpc:
-            logger.error("ERROR: will skip file, caught exception: %s", _xpc)
+        except TypeError:
+            logger.exception("ERROR: Will skip file. It caused an exception.")
 
 
 @cli.command(
@@ -190,7 +192,7 @@ def extract_meta(in_data: Path, separator: str) -> None:
 )
 @click.argument("in_data", type=click.Path(exists=True, resolve_path=True))
 def extract_uart(in_data: Path) -> None:
-    """Extracts uart from gpio-trace in file or directory containing shepherd-recordings"""
+    """Extract UART from GPIO-trace in file or directory containing shepherd-recordings."""
     files = path_to_flist(in_data)
     verbose_level = get_verbose_level()
     for file in files:
@@ -213,8 +215,8 @@ def extract_uart(in_data: Path) -> None:
                             # TODO: allow to skip Timestamp and export raw text
                             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)
+        except TypeError:
+            logger.exception("ERROR: Will skip file. It caused an exception.")
 
 
 @cli.command(short_help="Extracts gpio-trace from file or directory containing shepherd-recordings")
@@ -227,7 +229,7 @@ def extract_uart(in_data: Path) -> None:
     help="Set an individual csv-separator",
 )
 def extract_gpio(in_data: Path, separator: str) -> None:
-    """Extracts uart from gpio-trace in file or directory containing shepherd-recordings"""
+    """Extract UART from gpio-trace in file or directory containing shepherd-recordings."""
     files = path_to_flist(in_data)
     verbose_level = get_verbose_level()
     for file in files:
@@ -237,8 +239,8 @@ def extract_gpio(in_data: Path, separator: str) -> None:
                 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)
+        except TypeError:
+            logger.exception("ERROR: Will skip file. It caused an exception.")
 
 
 @cli.command(
@@ -261,9 +263,7 @@ def extract_gpio(in_data: Path, separator: str) -> None:
     help="Alternative Input to determine a downsample-factor (Choose One)",
 )
 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
-    """
+    """Create an array of down-sampled files from file or dir 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?
@@ -303,8 +303,8 @@ def downsample(in_data: Path, ds_factor: Optional[float], sample_rate: Optional[
                         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)
+        except TypeError:
+            logger.exception("ERROR: Will skip file. It caused an exception.")
 
 
 @cli.command(short_help="Plots IV-trace from file or directory containing shepherd-recordings")
@@ -351,7 +351,7 @@ def plot(
     height: int,
     multiplot: bool,  # noqa: FBT001
 ) -> None:
-    """Plots IV-trace from file or directory containing shepherd-recordings"""
+    """Plot IV-trace from file or directory containing shepherd-recordings."""
     files = path_to_flist(in_data)
     verbose_level = get_verbose_level()
     multiplot = multiplot and len(files) > 1
@@ -364,8 +364,8 @@ def plot(
                     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)
+        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)

{shepherd_data-2023.12.1 → shepherd_data-2024.4.2}/shepherd_data/ivonne.py

@@ -1,7 +1,5 @@
-"""prototype of a file-reader with various converters
-to generate valid shepherd-data for emulation
+"""file-reader with various converters to generate valid shepherd-data for emulation."""
 
-"""
 import errno
 import logging
 import math
@@ -34,7 +32,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 +100,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 +133,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 +162,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 +179,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 +213,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 +231,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 +264,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.2}/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)