PyDPEET 0.2.0__tar.gz → 0.3.0__tar.gz

pydpeet-0.3.0/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: PyDPEET
+Version: 0.3.0
+Summary: Python package to read, unify, and convert battery measurement data from arbitrary battery cyclers to Parquet files. This package also provides functions to process, evaluate, and visualise the standardised data.
+Author: Alexander Günter Hinrichsen, Jan Kalisch, Daniel Schröder, Cataldo De Simone
+Author-email: Anton Schlösser <a.schloesser@tu-berlin.de>, Martin Otto <m.otto.1@tu-berlin.de>
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENCE.md
+License-File: AUTHORS.md
+Requires-Dist: pandas==2.2.3
+Requires-Dist: numpy==2.2.4
+Requires-Dist: pyarrow==19.0.1
+Requires-Dist: python-calamine==0.3.1
+Requires-Dist: numba==0.64.0
+Requires-Dist: matplotlib==3.10.8
+Requires-Dist: scipy==1.17.1
+Requires-Dist: bibtexparser==1.4.4
+Requires-Dist: scikit-learn==1.8.0
+Requires-Dist: ipykernel>=7.2.0
+Dynamic: license-file
+
+# PyDPEET - Fast and Easy Battery Data Unification, Processing, and Analysis
+
+## Contact
+
+Feel free to open an issue on GitHub or use our email for direct enquiries: pydpeet@eet.tu-berlin.de.
+
+<!-- ## Technical Components
+alternatively: "Dependencies"
+Probably not necessary? -->
+
+## Project Goals
+
+PyDPEET is a Python package developed to handle battery measurement data from various cyclers and other measurement devices by
+* converting input data into a standardised format using Pandas data frames,
+* allowing users to merge multiple single tests into test series of one cell, and multiple test series into multi-cell measurement campaigns, and
+* adding sequence info either by automatically synthesising from an existing schedule or automatically analysing in case of unknown measurement procedure.
+
+Standardised data can then be analysed using various functions which add additional data columns to a data frame:
+* power, energy, capacity,
+* inner resistance,
+* state of charge (SOC), state of health (SOH),
+* OCV points, DVA and ICA,
+* and more...
+
+Processed data can be exported to highly efficient Parquet files to be stored and re-imported later -- or to CSV or XLSX formats to maintain legacy workflows.
+
+## Citing PyDPEET
+
+## Documentation
+
+![PyDPEET Workflow](docs/res/PyDPEET_Overview.svg "PyDPEET Workflow")
+
+### GitHub Pages
+
+* [PyDPEET homepage](https://eet-tub.github.io/pydpeet/)
+* [Installation](https://eet-tub.github.io/pydpeet/installation.html)
+* [API reference](https://eet-tub.github.io/pydpeet/api/index.html)
+* [Examples](https://eet-tub.github.io/pydpeet/examples/index.html)
+* [Developer Guide](https://eet-tub.github.io/pydpeet/developer.html)
+
+## Installation
+
+### For Users
+
+Please refer to the [installation guide](https://eet-tub.github.io/pydpeet/installation.html) at our GitHub Pages.
+
+### For Developers
+
+Please refer to the [developer guide](https://eet-tub.github.io/pydpeet/developer.html) at our GitHub Pages.
+
+## Current Status
+
+## Roadmap
+
+<!-- ## FAQ -->
+
+## Contributing to PyDPEET
+
+### Reporting Issues
+
+### Request for Data Conversion
+
+### Development Guidelines
+
+Please refer to the [developer guide](https://eet-tub.github.io/pydpeet/developer.html) at our GitHub Pages.
+
+<!-- ### Development Workflow -->
+
+<!-- #### Basic Setup -->
+
+<!-- #### Pre-Commit Hook -->
+
+<!-- #### Autogeneration -->
+
+<!-- #### Linting and Formatting -->

pydpeet-0.3.0/README.md

@@ -0,0 +1,75 @@
+# PyDPEET - Fast and Easy Battery Data Unification, Processing, and Analysis
+
+## Contact
+
+Feel free to open an issue on GitHub or use our email for direct enquiries: pydpeet@eet.tu-berlin.de.
+
+<!-- ## Technical Components
+alternatively: "Dependencies"
+Probably not necessary? -->
+
+## Project Goals
+
+PyDPEET is a Python package developed to handle battery measurement data from various cyclers and other measurement devices by
+* converting input data into a standardised format using Pandas data frames,
+* allowing users to merge multiple single tests into test series of one cell, and multiple test series into multi-cell measurement campaigns, and
+* adding sequence info either by automatically synthesising from an existing schedule or automatically analysing in case of unknown measurement procedure.
+
+Standardised data can then be analysed using various functions which add additional data columns to a data frame:
+* power, energy, capacity,
+* inner resistance,
+* state of charge (SOC), state of health (SOH),
+* OCV points, DVA and ICA,
+* and more...
+
+Processed data can be exported to highly efficient Parquet files to be stored and re-imported later -- or to CSV or XLSX formats to maintain legacy workflows.
+
+## Citing PyDPEET
+
+## Documentation
+
+![PyDPEET Workflow](docs/res/PyDPEET_Overview.svg "PyDPEET Workflow")
+
+### GitHub Pages
+
+* [PyDPEET homepage](https://eet-tub.github.io/pydpeet/)
+* [Installation](https://eet-tub.github.io/pydpeet/installation.html)
+* [API reference](https://eet-tub.github.io/pydpeet/api/index.html)
+* [Examples](https://eet-tub.github.io/pydpeet/examples/index.html)
+* [Developer Guide](https://eet-tub.github.io/pydpeet/developer.html)
+
+## Installation
+
+### For Users
+
+Please refer to the [installation guide](https://eet-tub.github.io/pydpeet/installation.html) at our GitHub Pages.
+
+### For Developers
+
+Please refer to the [developer guide](https://eet-tub.github.io/pydpeet/developer.html) at our GitHub Pages.
+
+## Current Status
+
+## Roadmap
+
+<!-- ## FAQ -->
+
+## Contributing to PyDPEET
+
+### Reporting Issues
+
+### Request for Data Conversion
+
+### Development Guidelines
+
+Please refer to the [developer guide](https://eet-tub.github.io/pydpeet/developer.html) at our GitHub Pages.
+
+<!-- ### Development Workflow -->
+
+<!-- #### Basic Setup -->
+
+<!-- #### Pre-Commit Hook -->
+
+<!-- #### Autogeneration -->
+
+<!-- #### Linting and Formatting -->

pydpeet-0.3.0/pyproject.toml

@@ -0,0 +1,118 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "PyDPEET"
+version = "0.3.0"
+description = "Python package to read, unify, and convert battery measurement data from arbitrary battery cyclers to Parquet files. This package also provides functions to process, evaluate, and visualise the standardised data."
+authors = [
+    { name = "Anton Schlösser", email = "a.schloesser@tu-berlin.de"},
+    { name = "Martin Otto", email = "m.otto.1@tu-berlin.de"},
+    { name = "Alexander Günter Hinrichsen" },
+    { name = "Jan Kalisch" },
+    { name = "Daniel Schröder" },
+    { name = "Cataldo De Simone" },
+]
+dependencies = [
+    "pandas==2.2.3",
+    "numpy==2.2.4",
+    "pyarrow==19.0.1",
+    "python-calamine==0.3.1",
+    "numba==0.64.0",
+    "matplotlib==3.10.8",
+    "scipy==1.17.1",
+    "bibtexparser==1.4.4",
+    "scikit-learn==1.8.0",
+    "ipykernel>=7.2.0",
+]
+requires-python = ">=3.12"
+readme = { file = "README.md", content-type = "text/markdown" }
+
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+
+[tool.pytest.ini_options]
+pythonpath = ["."]
+
+[dependency-groups]
+dev = [
+    "pre-commit",
+]
+docs = [
+  "sphinx",
+  "pydata-sphinx-theme",
+  "myst-parser",
+  "nbsphinx",
+  "sphinx-copybutton",
+  "bibtexparser",
+  "sphinx-design>=0.7.0",
+]
+test = [
+    "pytest",
+    "pytest-cov",
+    "pytest-xdist",
+    "pytest-rerunfailures",
+]
+mypy = [
+    "mypy>=1.0",
+    "types-python-dateutil",
+    "types-six",
+    "pre-commit",
+]
+
+
+[tool.ruff]
+# Set line length limit to a slightly higher value
+line-length = 120
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "B", "UP"]
+# E501: Ignore line length limit
+# UP007: Ignore this, cause automated "fixes" causes mypy errors
+#   foo: Union[int, str] = 1
+#   Use instead:
+#   foo: int | str = 1
+ignore = ["E501", "UP007"]
+
+[tool.ruff.lint.per-file-ignores]
+"*.ipynb" = ["E402"]
+
+[tool.ruff.format]
+ # Use this option to keep lists and parameters lists as multi-line code when ended by a trailing comma
+skip-magic-trailing-comma = false
+
+[tool.mypy]
+python_version = "3.12"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = false
+disallow_incomplete_defs = false
+check_untyped_defs = true
+#https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
+# Mypy will not try inferring the types of any 3rd party libraries
+# you have installed unless they either have declared themselves to
+# be PEP 561 compliant stub package (e.g. with a py.typed file) or have
+# registered themselves on typeshed, the repository of types for the standard
+# library and some 3rd party libraries.
+ignore_missing_imports = true
+exclude = [
+    "tests/",
+    "test/",
+    "docs/",
+    "benchmarks/",
+    "dev_utils/",
+    "res/",
+    ".*egg-info/",
+]
+
+# for local testing of test coverage
+[tool.coverage.run]
+source = ["src/pydpeet"]
+omit = [
+    "*/dev_utils/*",
+    "*/res/*",
+]

pydpeet-0.3.0/src/PyDPEET.egg-info/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: PyDPEET
+Version: 0.3.0
+Summary: Python package to read, unify, and convert battery measurement data from arbitrary battery cyclers to Parquet files. This package also provides functions to process, evaluate, and visualise the standardised data.
+Author: Alexander Günter Hinrichsen, Jan Kalisch, Daniel Schröder, Cataldo De Simone
+Author-email: Anton Schlösser <a.schloesser@tu-berlin.de>, Martin Otto <m.otto.1@tu-berlin.de>
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENCE.md
+License-File: AUTHORS.md
+Requires-Dist: pandas==2.2.3
+Requires-Dist: numpy==2.2.4
+Requires-Dist: pyarrow==19.0.1
+Requires-Dist: python-calamine==0.3.1
+Requires-Dist: numba==0.64.0
+Requires-Dist: matplotlib==3.10.8
+Requires-Dist: scipy==1.17.1
+Requires-Dist: bibtexparser==1.4.4
+Requires-Dist: scikit-learn==1.8.0
+Requires-Dist: ipykernel>=7.2.0
+Dynamic: license-file
+
+# PyDPEET - Fast and Easy Battery Data Unification, Processing, and Analysis
+
+## Contact
+
+Feel free to open an issue on GitHub or use our email for direct enquiries: pydpeet@eet.tu-berlin.de.
+
+<!-- ## Technical Components
+alternatively: "Dependencies"
+Probably not necessary? -->
+
+## Project Goals
+
+PyDPEET is a Python package developed to handle battery measurement data from various cyclers and other measurement devices by
+* converting input data into a standardised format using Pandas data frames,
+* allowing users to merge multiple single tests into test series of one cell, and multiple test series into multi-cell measurement campaigns, and
+* adding sequence info either by automatically synthesising from an existing schedule or automatically analysing in case of unknown measurement procedure.
+
+Standardised data can then be analysed using various functions which add additional data columns to a data frame:
+* power, energy, capacity,
+* inner resistance,
+* state of charge (SOC), state of health (SOH),
+* OCV points, DVA and ICA,
+* and more...
+
+Processed data can be exported to highly efficient Parquet files to be stored and re-imported later -- or to CSV or XLSX formats to maintain legacy workflows.
+
+## Citing PyDPEET
+
+## Documentation
+
+![PyDPEET Workflow](docs/res/PyDPEET_Overview.svg "PyDPEET Workflow")
+
+### GitHub Pages
+
+* [PyDPEET homepage](https://eet-tub.github.io/pydpeet/)
+* [Installation](https://eet-tub.github.io/pydpeet/installation.html)
+* [API reference](https://eet-tub.github.io/pydpeet/api/index.html)
+* [Examples](https://eet-tub.github.io/pydpeet/examples/index.html)
+* [Developer Guide](https://eet-tub.github.io/pydpeet/developer.html)
+
+## Installation
+
+### For Users
+
+Please refer to the [installation guide](https://eet-tub.github.io/pydpeet/installation.html) at our GitHub Pages.
+
+### For Developers
+
+Please refer to the [developer guide](https://eet-tub.github.io/pydpeet/developer.html) at our GitHub Pages.
+
+## Current Status
+
+## Roadmap
+
+<!-- ## FAQ -->
+
+## Contributing to PyDPEET
+
+### Reporting Issues
+
+### Request for Data Conversion
+
+### Development Guidelines
+
+Please refer to the [developer guide](https://eet-tub.github.io/pydpeet/developer.html) at our GitHub Pages.
+
+<!-- ### Development Workflow -->
+
+<!-- #### Basic Setup -->
+
+<!-- #### Pre-Commit Hook -->
+
+<!-- #### Autogeneration -->
+
+<!-- #### Linting and Formatting -->

{pydpeet-0.2.0 → pydpeet-0.3.0}/src/PyDPEET.egg-info/SOURCES.txt

@@ -14,6 +14,7 @@ src/pydpeet/citations/__init__.py
 src/pydpeet/citations/citeme.py
 src/pydpeet/citations/html_writer.py
 src/pydpeet/dev_utils/__init__.py
+src/pydpeet/dev_utils/check_test_coverge/check_test_coverage.py
 src/pydpeet/dev_utils/generate_inits/__init__.py
 src/pydpeet/dev_utils/generate_inits/generate_inits.py
 src/pydpeet/io/__init__.py
@@ -121,9 +122,8 @@ src/pydpeet/process/sequence/utils/processing/widen_constant_segments.py
 src/pydpeet/process/sequence/utils/visualize/__init__.py
 src/pydpeet/process/sequence/utils/visualize/visualize_data.py
 src/pydpeet/res/__init__.py
+src/pydpeet/res/res_for_unittests/res.py
 src/pydpeet/utils/__init__.py
-src/pydpeet/utils/logging_style.py
-test/test_datatypes.py
-test/test_directory_standardization.py
-test/test_export.py
-test/test_map.py
+src/pydpeet/utils/assert_raises_and_print.py
+src/pydpeet/utils/guardrails.py
+src/pydpeet/utils/logging_style.py

pydpeet-0.3.0/src/PyDPEET.egg-info/requires.txt

@@ -0,0 +1,10 @@
+pandas==2.2.3
+numpy==2.2.4
+pyarrow==19.0.1
+python-calamine==0.3.1
+numba==0.64.0
+matplotlib==3.10.8
+scipy==1.17.1
+bibtexparser==1.4.4
+scikit-learn==1.8.0
+ipykernel>=7.2.0

{pydpeet-0.2.0/src/pydpeet/io → pydpeet-0.3.0/src/pydpeet/citations}/__init__.py

@@ -4,4 +4,4 @@ Created: 2026-03-06 15:11:49
 """
 
 # Restrictive package init: start with no public API
-__all__ = []
+__all__: list[str] = []

{pydpeet-0.2.0 → pydpeet-0.3.0}/src/pydpeet/citations/citeme.py

@@ -8,7 +8,6 @@ import pathlib
 
 from bibtexparser.bibdatabase import BibDatabase
 from bibtexparser.bwriter import BibTexWriter
-from six import iteritems
 
 from .html_writer import BibHtmlWriter
 
@@ -16,9 +15,10 @@ from .html_writer import BibHtmlWriter
 # Singleton!
 class CiteMe:
     # Class variable!
-    __instance = None
+    __instance: "CiteMe | None" = None
     __check_fields = True
     __pedantic = False
+    references: dict
 
     # Override new to make this a singleton class
     # taken from http://python-3-patterns-idioms-test.readthedocs.io/en/latest/Singleton.html#id5
@@ -42,7 +42,7 @@ class CiteMe:
 
     def print_references(self):
         for ref_type in self.references:
-            for _, citation in iteritems(self.references[ref_type]):
+            for _, citation in self.references[ref_type].items():
                 # print(ref_type, handle, citation.description)
                 print(citation.description)
 
@@ -50,7 +50,7 @@ class CiteMe:
         db = BibDatabase()
         db.entries = []
         for ref_type in self.references:
-            for handle, citation in iteritems(self.references[ref_type]):
+            for handle, citation in self.references[ref_type].items():
                 description = citation.description
                 description["ENTRYTYPE"] = citation.type
                 description["ID"] = handle
@@ -67,7 +67,7 @@ class CiteMe:
         db = BibDatabase()
         db.entries = []
         for ref_type in self.references:
-            for handle, citation in iteritems(self.references[ref_type]):
+            for handle, citation in self.references[ref_type].items():
                 description = citation.description
                 description["ENTRYTYPE"] = citation.type
                 description["ID"] = handle
@@ -198,8 +198,8 @@ class incollection(Citation):
 
 
 class inproceedings(Citation):
-    def __init__(self, handle, description):
-        super().__init__(handle, description, "inproceedings")
+    def __init__(self, handle, description, the_type="inproceedings"):
+        super().__init__(handle, description, the_type)
         self._required = ["author", "title", "booktitle", "year"]
         self._optional = [
             "editor",