User Guide

Start to learn the battery-data-toolkit by understanding the BatteryDataset object. Either continue with schemas if planning to make a new dataset, or post-processing if using already-existing data.

Contents:

• The BatteryDataset Object
  • Structure of a BatteryDataset
  • Creating a BatteryDataset
  • Loading and Saving
• Reading and Writing Datasets
  • Reading Data
  • Writing Data
• File Formats
  • HDF5
  • Parquet
• Describing Battery Data
  • Source Metadata
  • Column Schemas
• Post-Processing
  • Integral Quantities
  • Time
• Consistency Checks
  • Checking Sign Conventions
• Streaming Battery Data
  • Reading Data as a Stream
  • Streaming Data to a File