PyDPEET 0.3.1__tar.gz → 0.4.0__tar.gz

pydpeet-0.4.0/AUTHORS.md

@@ -0,0 +1,36 @@
+# Notes
+
+- All authors were sorted alphabetically according to their last names.
+- For authors who only want their user name to be displayed, the first letter of said name was used.
+- If you feel that your name might be missing from that list, please contact the project leads or open a PR.
+- If you find your name on this list but want to stay anonymous, please contact us to have your name removed.
+
+# Contributors
+
+## Project Lead
+
+- Martin Otto (MAtahualpa)
+- Anton Schlösser (schlanto)
+
+## Development Lead
+
+- Daniel Schröder (Plompudu, daniel_shr)
+
+## Developers
+
+- Max Thorn (northmaybe)
+
+## Inactive
+
+- Cataldo De Simone
+- Alexander Hinrichsen
+- Jan Kalisch
+
+## Initial Developers
+
+- Cataldo De Simone
+- Alexander Hinrichsen
+- Jan Kalisch
+- Martin Otto (MAtahualpa)
+- Anton Schlösser (schlanto)
+- Daniel Schröder (daniel_shr)

{pydpeet-0.3.1/src/PyDPEET.egg-info → pydpeet-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyDPEET
-Version: 0.3.1
+Version: 0.4.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: Anton Schlösser, Martin Otto, Alexander Günter Hinrichsen, Jan Kalisch, Daniel Schröder, Cataldo De Simone
 Maintainer-email: PyDPEET Team <pydpeet@eet.tu-berlin.de>
@@ -8,8 +8,8 @@ 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: pandas==3.0.3
+Requires-Dist: numpy==2.3.3
 Requires-Dist: pyarrow==19.0.1
 Requires-Dist: python-calamine>=0.3.1
 Requires-Dist: numba==0.64.0
@@ -20,6 +20,22 @@ Requires-Dist: scikit-learn==1.8.0
 Requires-Dist: ipykernel>=7.2.0
 Dynamic: license-file
 
+<div align="center">
+
+[![Release](https://img.shields.io/github/v/release/eet-tub/pydpeet)](https://github.com/eet-tub/pydpeet/releases)
+[![PyPI](https://img.shields.io/pypi/v/pydpeet)](https://pypi.org/project/pydpeet/)
+[![Docs](https://img.shields.io/badge/docs-latest-blue)](https://eet-tub.github.io/pydpeet/)
+[![License](https://img.shields.io/github/license/eet-tub/pydpeet)](LICENSE)
+
+</div>
+
+<!-- [![Python](https://img.shields.io/pypi/pyversions/pydpeet)](https://pypi.org/project/pydpeet/)
+[![CI](https://github.com/eet-tub/pydpeet/actions/workflows/github-ci.yml/badge.svg)](https://github.com/eet-tub/pydpeet/actions/workflows/github-ci.yml)
+[![DOI](https://zenodo.org/badge/DOI/<DOI>.svg)](https://doi.org/<DOI>)
+[![Coverage](https://codecov.io/gh/eet-tub/pydpeet/branch/main/graph/badge.svg)](https://codecov.io/gh/eet-tub/pydpeet)
+[![Downloads](https://img.shields.io/pypi/dm/pydpeet)](https://pypi.org/project/pydpeet/)
+[![Status](https://joss.theoj.org/papers/<paper-id>/status.svg)](...) -->
+
 # PyDPEET - Fast and Easy Battery Data Unification, Processing, and Analysis
 
 ## Contact
@@ -64,34 +80,56 @@ Processed data can be exported to highly efficient Parquet files to be stored an
 
 ### For Users
 
-Please refer to the [installation guide](https://eet-tub.github.io/pydpeet/installation.html) at our GitHub Pages.
+Install PyDPEET directly from PyPI using uv or pip.
+
+```
+uv add pydpeet
+```
+
+or
+
+```
+pip install pydpeet
+```
+
+For detailed installation instructions, see 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
+<!-- ## Current Status -->
 
 ## Roadmap
 
+Planned features and ongoing work are tracked in the [Roadmap](https://github.com/orgs/eet-tub/projects/3) at our GitHub Projects.
+
 <!-- ## FAQ -->
 
 ## Contributing to PyDPEET
 
 ### Reporting Issues
 
-### Request for Data Conversion
-
-### Development Guidelines
+If you encounter an issue, please open a GitHub issue and provide as much information as possible, including:
 
-Please refer to the [developer guide](https://eet-tub.github.io/pydpeet/developer.html) at our GitHub Pages.
+- a minimal reproducible example
+- cycler model
+- software version
+- export settings
+- battery information
+- error messages and stack traces (if available)
 
-<!-- ### Development Workflow -->
+### Request for Data Conversion
+If PyDPEET cannot read or convert your data, please open an issue or send us sample data via email (pydpeet@eet.tu-berlin.de).
 
-<!-- #### Basic Setup -->
+- cycler model
+- software version
+- export settings
+- battery type
+- measurement description
 
-<!-- #### Pre-Commit Hook -->
+### Contributing New Features
 
-<!-- #### Autogeneration -->
+Contributions are always welcome! If you would like to add a new feature, we recommend discussing your idea in a GitHub issue before starting implementation. This helps avoid duplicate work and ensures that the proposed functionality aligns with the project's goals.
 
-<!-- #### Linting and Formatting -->
+Please refer to the [Developer Guide](https://eet-tub.github.io/pydpeet/developer.html) for information on setting up a development environment, coding standards, testing, documentation, and the pull request workflow.

pydpeet-0.4.0/README.md

@@ -0,0 +1,113 @@
+<div align="center">
+
+[![Release](https://img.shields.io/github/v/release/eet-tub/pydpeet)](https://github.com/eet-tub/pydpeet/releases)
+[![PyPI](https://img.shields.io/pypi/v/pydpeet)](https://pypi.org/project/pydpeet/)
+[![Docs](https://img.shields.io/badge/docs-latest-blue)](https://eet-tub.github.io/pydpeet/)
+[![License](https://img.shields.io/github/license/eet-tub/pydpeet)](LICENSE)
+
+</div>
+
+<!-- [![Python](https://img.shields.io/pypi/pyversions/pydpeet)](https://pypi.org/project/pydpeet/)
+[![CI](https://github.com/eet-tub/pydpeet/actions/workflows/github-ci.yml/badge.svg)](https://github.com/eet-tub/pydpeet/actions/workflows/github-ci.yml)
+[![DOI](https://zenodo.org/badge/DOI/<DOI>.svg)](https://doi.org/<DOI>)
+[![Coverage](https://codecov.io/gh/eet-tub/pydpeet/branch/main/graph/badge.svg)](https://codecov.io/gh/eet-tub/pydpeet)
+[![Downloads](https://img.shields.io/pypi/dm/pydpeet)](https://pypi.org/project/pydpeet/)
+[![Status](https://joss.theoj.org/papers/<paper-id>/status.svg)](...) -->
+
+# 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
+
+Install PyDPEET directly from PyPI using uv or pip.
+
+```
+uv add pydpeet
+```
+
+or
+
+```
+pip install pydpeet
+```
+
+For detailed installation instructions, see 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
+
+Planned features and ongoing work are tracked in the [Roadmap](https://github.com/orgs/eet-tub/projects/3) at our GitHub Projects.
+
+<!-- ## FAQ -->
+
+## Contributing to PyDPEET
+
+### Reporting Issues
+
+If you encounter an issue, please open a GitHub issue and provide as much information as possible, including:
+
+- a minimal reproducible example
+- cycler model
+- software version
+- export settings
+- battery information
+- error messages and stack traces (if available)
+
+### Request for Data Conversion
+If PyDPEET cannot read or convert your data, please open an issue or send us sample data via email (pydpeet@eet.tu-berlin.de).
+
+- cycler model
+- software version
+- export settings
+- battery type
+- measurement description
+
+### Contributing New Features
+
+Contributions are always welcome! If you would like to add a new feature, we recommend discussing your idea in a GitHub issue before starting implementation. This helps avoid duplicate work and ensures that the proposed functionality aligns with the project's goals.
+
+Please refer to the [Developer Guide](https://eet-tub.github.io/pydpeet/developer.html) for information on setting up a development environment, coding standards, testing, documentation, and the pull request workflow.

{pydpeet-0.3.1 → pydpeet-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "PyDPEET"
-version = "0.3.1"
+version = "0.4.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" },
@@ -20,8 +20,8 @@ maintainers = [
 ]
 
 dependencies = [
-    "pandas==2.2.3",
-    "numpy==2.2.4",
+    "pandas==3.0.3",
+    "numpy==2.3.3",
     "pyarrow==19.0.1",
     "python-calamine>=0.3.1",
     "numba==0.64.0",
@@ -109,7 +109,7 @@ exclude = [
     "test/",
     "docs/",
     "benchmarks/",
-    "dev_utils/",
+    "_dev_utils/",
     "res/",
     ".*egg-info/",
 ]
@@ -118,6 +118,6 @@ exclude = [
 [tool.coverage.run]
 source = ["src/pydpeet"]
 omit = [
-    "*/dev_utils/*",
+    "*/_dev_utils/*",
     "*/res/*",
 ]

{pydpeet-0.3.1 → pydpeet-0.4.0/src/PyDPEET.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyDPEET
-Version: 0.3.1
+Version: 0.4.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: Anton Schlösser, Martin Otto, Alexander Günter Hinrichsen, Jan Kalisch, Daniel Schröder, Cataldo De Simone
 Maintainer-email: PyDPEET Team <pydpeet@eet.tu-berlin.de>
@@ -8,8 +8,8 @@ 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: pandas==3.0.3
+Requires-Dist: numpy==2.3.3
 Requires-Dist: pyarrow==19.0.1
 Requires-Dist: python-calamine>=0.3.1
 Requires-Dist: numba==0.64.0
@@ -20,6 +20,22 @@ Requires-Dist: scikit-learn==1.8.0
 Requires-Dist: ipykernel>=7.2.0
 Dynamic: license-file
 
+<div align="center">
+
+[![Release](https://img.shields.io/github/v/release/eet-tub/pydpeet)](https://github.com/eet-tub/pydpeet/releases)
+[![PyPI](https://img.shields.io/pypi/v/pydpeet)](https://pypi.org/project/pydpeet/)
+[![Docs](https://img.shields.io/badge/docs-latest-blue)](https://eet-tub.github.io/pydpeet/)
+[![License](https://img.shields.io/github/license/eet-tub/pydpeet)](LICENSE)
+
+</div>
+
+<!-- [![Python](https://img.shields.io/pypi/pyversions/pydpeet)](https://pypi.org/project/pydpeet/)
+[![CI](https://github.com/eet-tub/pydpeet/actions/workflows/github-ci.yml/badge.svg)](https://github.com/eet-tub/pydpeet/actions/workflows/github-ci.yml)
+[![DOI](https://zenodo.org/badge/DOI/<DOI>.svg)](https://doi.org/<DOI>)
+[![Coverage](https://codecov.io/gh/eet-tub/pydpeet/branch/main/graph/badge.svg)](https://codecov.io/gh/eet-tub/pydpeet)
+[![Downloads](https://img.shields.io/pypi/dm/pydpeet)](https://pypi.org/project/pydpeet/)
+[![Status](https://joss.theoj.org/papers/<paper-id>/status.svg)](...) -->
+
 # PyDPEET - Fast and Easy Battery Data Unification, Processing, and Analysis
 
 ## Contact
@@ -64,34 +80,56 @@ Processed data can be exported to highly efficient Parquet files to be stored an
 
 ### For Users
 
-Please refer to the [installation guide](https://eet-tub.github.io/pydpeet/installation.html) at our GitHub Pages.
+Install PyDPEET directly from PyPI using uv or pip.
+
+```
+uv add pydpeet
+```
+
+or
+
+```
+pip install pydpeet
+```
+
+For detailed installation instructions, see 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
+<!-- ## Current Status -->
 
 ## Roadmap
 
+Planned features and ongoing work are tracked in the [Roadmap](https://github.com/orgs/eet-tub/projects/3) at our GitHub Projects.
+
 <!-- ## FAQ -->
 
 ## Contributing to PyDPEET
 
 ### Reporting Issues
 
-### Request for Data Conversion
-
-### Development Guidelines
+If you encounter an issue, please open a GitHub issue and provide as much information as possible, including:
 
-Please refer to the [developer guide](https://eet-tub.github.io/pydpeet/developer.html) at our GitHub Pages.
+- a minimal reproducible example
+- cycler model
+- software version
+- export settings
+- battery information
+- error messages and stack traces (if available)
 
-<!-- ### Development Workflow -->
+### Request for Data Conversion
+If PyDPEET cannot read or convert your data, please open an issue or send us sample data via email (pydpeet@eet.tu-berlin.de).
 
-<!-- #### Basic Setup -->
+- cycler model
+- software version
+- export settings
+- battery type
+- measurement description
 
-<!-- #### Pre-Commit Hook -->
+### Contributing New Features
 
-<!-- #### Autogeneration -->
+Contributions are always welcome! If you would like to add a new feature, we recommend discussing your idea in a GitHub issue before starting implementation. This helps avoid duplicate work and ensures that the proposed functionality aligns with the project's goals.
 
-<!-- #### Linting and Formatting -->
+Please refer to the [Developer Guide](https://eet-tub.github.io/pydpeet/developer.html) for information on setting up a development environment, coding standards, testing, documentation, and the pull request workflow.

{pydpeet-0.3.1 → pydpeet-0.4.0}/src/PyDPEET.egg-info/SOURCES.txt

@@ -10,13 +10,28 @@ src/PyDPEET.egg-info/top_level.txt
 src/pydpeet/__init__.py
 src/pydpeet/settings.py
 src/pydpeet/version.py
+src/pydpeet/_dev_utils/__init__.py
+src/pydpeet/_dev_utils/list_definitions.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/_dev_utils/regenerate_test_references/__init__.py
+src/pydpeet/_dev_utils/regenerate_test_references/regenerate_add_capacity.py
+src/pydpeet/_dev_utils/regenerate_test_references/regenerate_add_primitive_segments.py
+src/pydpeet/_dev_utils/regenerate_test_references/regenerate_add_resistance_internal.py
+src/pydpeet/_dev_utils/regenerate_test_references/regenerate_add_soc.py
+src/pydpeet/_dev_utils/regenerate_test_references/regenerate_convert.py
+src/pydpeet/_dev_utils/regenerate_test_references/regenerate_df_primitives_correction.py
+src/pydpeet/_dev_utils/regenerate_test_references/regenerate_extract_ocv_iocv.py
+src/pydpeet/_dev_utils/regenerate_test_references/regenerate_extract_sequence_overview.py
+src/pydpeet/_dev_utils/regenerate_test_references/regenerate_filter_and_split_df_by_blocks.py
+src/pydpeet/_dev_utils/regenerate_test_references/regenerate_generate_instructions.py
+src/pydpeet/_dev_utils/regenerate_test_references/regenerate_merge_into_series.py
+src/pydpeet/_dev_utils/regenerate_test_references/regenerate_read.py
+src/pydpeet/_dev_utils/regenerate_test_references/run_all.py
 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
 src/pydpeet/io/convert.py
 src/pydpeet/io/map.py
@@ -70,7 +85,6 @@ src/pydpeet/io/utils/__init__.py
 src/pydpeet/io/utils/ext_path.py
 src/pydpeet/io/utils/formatter_utils.py
 src/pydpeet/io/utils/load_custom_module.py
-src/pydpeet/io/utils/timing.py
 src/pydpeet/process/__init__.py
 src/pydpeet/process/analyze/__init__.py
 src/pydpeet/process/analyze/average.py
@@ -85,8 +99,6 @@ src/pydpeet/process/analyze/soh.py
 src/pydpeet/process/analyze/utils.py
 src/pydpeet/process/analyze/configs/__init__.py
 src/pydpeet/process/analyze/configs/battery_config.py
-src/pydpeet/process/analyze/configs/ocv_config.py
-src/pydpeet/process/analyze/configs/step_analyzer_config.py
 src/pydpeet/process/analyze/extract/__init__.py
 src/pydpeet/process/analyze/extract/dva_ica.py
 src/pydpeet/process/analyze/extract/ocv.py
@@ -99,11 +111,7 @@ src/pydpeet/process/sequence/configs/config.py
 src/pydpeet/process/sequence/utils/__init__.py
 src/pydpeet/process/sequence/utils/annotate/__init__.py
 src/pydpeet/process/sequence/utils/annotate/annotate_primitives.py
-src/pydpeet/process/sequence/utils/configs/CONFIG_Fallback.py
-src/pydpeet/process/sequence/utils/configs/CONFIG_preprocessing.py
-src/pydpeet/process/sequence/utils/configs/__init__.py
 src/pydpeet/process/sequence/utils/console_prints/__init__.py
-src/pydpeet/process/sequence/utils/console_prints/log_time.py
 src/pydpeet/process/sequence/utils/postprocessing/__init__.py
 src/pydpeet/process/sequence/utils/postprocessing/df_primitives_correction.py
 src/pydpeet/process/sequence/utils/postprocessing/filter_df.py
@@ -126,4 +134,5 @@ src/pydpeet/res/res_for_unittests/res.py
 src/pydpeet/utils/__init__.py
 src/pydpeet/utils/assert_raises_and_print.py
 src/pydpeet/utils/guardrails.py
+src/pydpeet/utils/log_time.py
 src/pydpeet/utils/logging_style.py

{pydpeet-0.3.1 → pydpeet-0.4.0}/src/PyDPEET.egg-info/requires.txt

@@ -1,5 +1,5 @@
-pandas==2.2.3
-numpy==2.2.4
+pandas==3.0.3
+numpy==2.3.3
 pyarrow==19.0.1
 python-calamine>=0.3.1
 numba==0.64.0

pydpeet-0.4.0/src/pydpeet/__init__.py

@@ -0,0 +1,107 @@
+"""
+Auto-generated __init__ file.
+Created: 2026-03-06 15:11:49
+"""
+
+# Re-export selected names from source modules
+
+from pydpeet.citations.citeme import print_references, write_to_bibtex
+from pydpeet.io.configs.config import DataOutputFiletype, ReadConfig
+from pydpeet.io.convert import convert
+from pydpeet.io.read import read
+from pydpeet.io.utils import load_custom_module
+from pydpeet.io.write import write
+from pydpeet.process.analyze.capacity import add_capacity, add_charge_throughput
+from pydpeet.process.analyze.configs.battery_config import BatteryConfig, battery_config_wrapper
+from pydpeet.process.analyze.cycle import add_equivalent_full_cycles
+from pydpeet.process.analyze.efficiency import add_efficiency_coulomb
+from pydpeet.process.analyze.energy import add_cumulative_energy
+from pydpeet.process.analyze.extract.dva_ica import extract_ocv_dva_ica
+from pydpeet.process.analyze.extract.ocv import extract_ocv_iocv
+from pydpeet.process.analyze.power import add_power
+from pydpeet.process.analyze.resistance import add_resistance_internal
+from pydpeet.process.analyze.soc import SocMethod, add_soc
+from pydpeet.process.analyze.soh import add_soh
+from pydpeet.process.merge.series import merge_into_campaign, merge_into_series
+from pydpeet.process.sequence.configs.config import (
+    DeviceConfig,
+    PrimitiveConfig,
+    SequenceOverviewConfig,
+    VisualizationConfig,
+    primitive_config_wrapper,
+    sequence_overview_config_wrapper,
+    visualization_config_wrapper,
+)
+from pydpeet.process.sequence.step_analyzer import add_primitive_segments, extract_sequence_overview
+from pydpeet.process.sequence.utils.postprocessing.df_primitives_correction import df_primitives_correction
+from pydpeet.process.sequence.utils.postprocessing.filter_df import (
+    filter_and_split_df_by_blocks,
+    filter_df,
+    return_or_print_blocks,
+    split_df_by_blocks,
+)
+from pydpeet.process.sequence.utils.postprocessing.generate_instructions import extract_instructions
+from pydpeet.process.sequence.utils.preprocessing.calculate_thresholds import calculate_minimum_definitive_differences
+from pydpeet.process.sequence.utils.visualize.visualize_data import visualize_phases
+from pydpeet.utils.logging_style import set_logging_style
+
+# Public API for this package
+__all__ = [
+    # Tutorial 01
+    "ReadConfig",
+    "read",
+    "DataOutputFiletype",
+    "load_custom_module",
+    "merge_into_series",
+    "write",
+    "set_logging_style",
+    "print_references",
+    "write_to_bibtex",
+    # Tutorial 02
+    "add_primitive_segments",
+    "PrimitiveConfig",
+    "primitive_config_wrapper",
+    "DeviceConfig",
+    "calculate_minimum_definitive_differences",
+    "visualize_phases",
+    "VisualizationConfig",
+    "visualization_config_wrapper",
+    "df_primitives_correction",  # TODO Tut 2
+    # "print_references",
+    # "write_to_bibtex",
+    # Tutorial 03
+    "extract_sequence_overview",
+    "SequenceOverviewConfig",
+    "sequence_overview_config_wrapper",
+    "extract_instructions",
+    # "print_references",
+    # "write_to_bibtex",
+    # Tutorial 04
+    "filter_and_split_df_by_blocks",  # TODO why 3 variants?
+    "split_df_by_blocks",  # TODO why 3 variants?
+    "filter_df",  # TODO why 3 variants?
+    "return_or_print_blocks",
+    "extract_ocv_iocv",
+    "extract_ocv_dva_ica",
+    # "print_references",
+    # "write_to_bibtex",
+    # Tutorial 05
+    "SocMethod",
+    "add_capacity",
+    "BatteryConfig",
+    "battery_config_wrapper",
+    "add_charge_throughput",
+    "add_cumulative_energy",
+    "add_efficiency_coulomb",
+    "add_equivalent_full_cycles",
+    "add_power",
+    "add_resistance_internal",
+    "add_soc",
+    "add_soh",
+    # "print_references",
+    # "write_to_bibtex",
+    # TODO what / why is this?
+    "merge_into_campaign",
+    # TODO discuss if still needed, due to read()
+    "convert",
+]