feature/bokeh and bugfix/tab-readers

.gitignore

@@ -45,7 +45,8 @@ share/python-wheels/
 pip-log.txt
 pip-delete-this-directory.txt
 
-# Unit test / coverage reports
+# Unit test / coverage reports / in progress
+inprogress/
 references/
 reports/
 htmlcov/

CHANGELOG.md

@@ -3,13 +3,17 @@
 ## [Unreleased](https://github.com/NatLabRockies/ampworks)
 
 ### New Features
+- New `interactive_plotly` and `interactive_bokeh` methods with `kind` line/scatter option ([#31](https://github.com/NatLabRockies/ampworks/pull/31))
 - New hidden `auxiliary` module for repeated logic across package (only for devs, for now) ([#30](https://github.com/NatLabRockies/ampworks/pull/30))
 
+### Deprecations
+- `interactive_xy_plot` deprecated in favor of `interactive_plotly` ([#31](https://github.com/NatLabRockies/ampworks/pull/31))
+
 ### Optimizations
 None.
 
 ### Bug Fixes
-None.
+- Extra tabs in some `.txt` files were creating read errors, now ignore ragged columns ([#31](https://github.com/NatLabRockies/ampworks/pull/31))
 
 ### Chores
 - Use base class `_RangeLabel` for both cycle and section labels ([#29](https://github.com/NatLabRockies/ampworks/pull/29))

docs/source/conf.py

@@ -146,11 +146,12 @@
 # to keep in the ampworks documentation. The rest is excluded.
 
 dataset_keep = [
-    'zero_time',
-    'zero_below',
     'downsample',
     'enforce_monotonic',
-    'interactive_xy_plot',
+    'interactive_plotly',
+    'interactive_bokeh',
+    'zero_below',
+    'zero_time',
 ]
 
 richres_keep = ['copy']

pyproject.toml

@@ -6,8 +6,11 @@ build-backend = "setuptools.build_meta"
 name = "ampworks"
 readme = "README.md"
 dynamic = ["version"]
-description = "Processing and visualization tools for battery experiments."
-keywords = ["battery", "data", "analysis", "ICA", "dQdV", "GITT", "ICI"]
+description = "Battery data analysis and visualization tools."
+keywords = [
+    "battery", "data", "analysis", "model", "degradation", "ecm", "spm", "p2d",
+    "parameters", "visualization", "dqdv", "gitt", "ici", "hppc", "ocv",
+]
 requires-python = ">=3.10,<3.15"
 license = "BSD-3-Clause"
 license-files = ["LICENSE"]
@@ -33,9 +36,11 @@ dependencies = [
     "tqdm",
     "xlrd",
     "numpy",
+    "bokeh",
     "pandas",
     "polars",
     "plotly",
+    "IPython",
     "pyarrow",
     "seaborn",
     "openpyxl",

src/ampworks/_auxiliary.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Sequence
+from typing import TYPE_CHECKING
 
 from scipy.integrate import cumulative_trapezoid
 
@@ -78,7 +78,7 @@ def _calc_soc(data: amp.Dataset, charging: bool | None = None) -> None:
 
 def _calc_relative_time(
     data: amp.Dataset,
-    groupby_cols: str | Sequence[str],
+    groupby_cols: str | list[str],
     col_name: str = 'RelativeTime',
 ) -> None:
     """
@@ -93,7 +93,7 @@ def _calc_relative_time(
     ----------
     data : Dataset
         DataFrame with a 'Seconds' column, and columns needed for grouping.
-    groupby_cols : str or Sequence[str]
+    groupby_cols : str or list[str]
         Column names to group by before computing relative time.
     col_name : str, optional
         Name of the output column. Defaults to `'RelativeTime'`.