Get started

Quickstart

Install the CLI, explain a source file, convert it into a BDS table, and validate the output before it enters analysis.

bds quickstart

Install

Python 3.10 or newer is required. Optional extras are available for YAML, MATLAB, and BioLogic MPR input families.

$ pip install --upgrade battery-data-standard

Explain

Review data-kind detection, adapter selection, column mapping, current-sign evidence, repairs, and recommended next actions.

$ bds explain raw_export.csv --text

Convert

Write CSV or Parquet outputs plus JSON and PDF conversion reports named from the output stem.

$ bds convert raw_export.csv normalized.bds.csv --cycler auto --report auto

Validate

Validation accepts user-facing export labels and checks the required BDS time-series fields.

$ bds validate normalized.bds.csv

Supported formats

Review adapter scope for NEWARE, Arbin, Maccor, BioLogic, Repower, PEC, Novonix, BaSyTec, LANDT, and generic inputs.

Understand required canonical columns, export labels, and beta-period compatibility expectations.