https://github.com/ROVI-org/battery-data-toolkit

Utilities for reading and manipulating battery testing data
https://github.com/ROVI-org/battery-data-toolkit

Last synced: 3 days ago
JSON representation

Utilities for reading and manipulating battery testing data

• Host: GitHub
• URL: https://github.com/ROVI-org/battery-data-toolkit
• Owner: ROVI-org
• License: apache-2.0
• Created: 2020-03-10T14:46:00.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2025-03-12T16:25:36.000Z (about 2 months ago)
• Last Synced: 2025-05-02T17:59:52.167Z (8 days ago)
• Language: Jupyter Notebook
• Homepage: https://rovi-org.github.io/battery-data-toolkit/
• Size: 2.01 MB
• Stars: 45
• Watchers: 3
• Forks: 11
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• open-sustainable-technology - Battery Data Toolkit - Converts battery testing data from native formats to a standardized HDF5 file. (Energy Storage / Battery)

README

        
# Battery Data Toolkit

[![Python Package](https://github.com/rovi-org/battery-data-toolkit/actions/workflows/python-package.yml/badge.svg)](https://github.com/rovi-org/battery-data-toolkit/actions/workflows/python-package.yml)

[![Deploy Docs](https://github.com/ROVI-org/battery-data-toolkit/actions/workflows/gh-pages.yml/badge.svg?branch=main)](https://rovi-org.github.io/battery-data-toolkit/)

[![Coverage Status](https://coveralls.io/repos/github/ROVI-org/battery-data-toolkit/badge.svg?branch=main)](https://coveralls.io/github/ROVI-org/battery-data-toolkit?branch=main)

[![PyPI version](https://badge.fury.io/py/battery-data-toolkit.svg)](https://badge.fury.io/py/battery-data-toolkit)

The battery-data-toolkit, `battdat`, creates consistently-formatted collections of battery data.

The library has three main purposes:

1. *Storing battery data in standardized formats.* ``battdat`` stores data in 

   [HDF5 or Parquet files](https://rovi-org.github.io/battery-data-toolkit/user-guide/formats.html) which include 

   [extensive metadata](https://rovi-org.github.io/battery-data-toolkit/user-guide/schemas/index.html). 

2. *Interfacing battery data with the PyData ecosystem*. The core data model,

   [``BatteryDataset``](https://rovi-org.github.io/battery-data-toolkit/user-guide/dataset.html),

   is built atop Pandas DataFrames.

3. *Providing standard implementations of common analysis techniques*. ``battdat`` implements functions which

   [ensure quality](https://rovi-org.github.io/battery-data-toolkit/user-guide/consistency/index.html)

   or [perform common analyses](https://rovi-org.github.io/battery-data-toolkit/user-guide/post-processing/index.html).

## Installation

Install ``battdat`` with pip: `pip install battery-data-toolkit`

## Documentation

Find the documentation at: https://rovi-org.github.io/battery-data-toolkit/

## Support

The motivation and funding for this project came from the Rapid Operational Validation Initiative (ROVI) sponsored by the Office of Electricity.

The focus of ROVI is "to greatly reduce time required for emerging energy storage technologies to go from lab to market by developing new tools that will accelerate the testing and validation process needed to ensure commercial success." 

If interested, you can read more about ROVI here.