Documentation

Everything you need to know about the Battery Data Format and the batterydf Python package.

Getting Started

Install the package and learn the basics of working with BDF.

BDF Specification

Complete reference for all required, recommended, and optional fields.

API Reference

Full API documentation for the batterydf Python package.

Documentation

Core Concepts

BDF Schema OverviewFile Naming ConventionsUnit ConventionsMetadata & JSON-LD

Python Package

Installation GuideQuick Start TutorialSupported FormatsCLI Reference

Machine-Readable Standards

BDF OntologyJSON-LD Integration

External Resources

Py

PyPI Package

View the batterydf package on PyPI

GitHub Repositories

Browse all BDA projects on GitHub

Need Help?

Can't find what you're looking for? Ask questions on our community forum or open an issue on GitHub.

Ask on DiscourseOpen an Issue