.. toctree::
   :includehidden:
   :hidden:

   Get Started <get_started>
   Examples <examples/index>
   User Guide <user_guide>
   Reference <reference>

Battery Data Format (bdf)
=========================

The ``bdf`` package provides tools to read, normalize, validate, repair, and
visualize battery cycler data into a consistent Battery Data Format (BDF).

Check out these resources to get started!
-----------------------------------------

.. grid::

    .. grid-item-card::
        :link: get_started.html

        :octicon:`rocket;1em;sd-text-info`  Get Started
        ^^^^^^^^^^^
        Install, overview, and first steps

    .. grid-item-card::
        :link: examples/index.html

        :octicon:`play;1em;sd-text-info`  Examples
        ^^^^^^^^^^
        Walk through end-to-end notebooks and workflows

.. grid::

    .. grid-item-card::
        :link: user_guide.html

        :octicon:`book;1em;sd-text-info`  User Guide
        ^^^^^^^^^^
        Formats, workflows, metadata, and registry

    .. grid-item-card::
        :link: reference.html

        :octicon:`terminal;1em;sd-text-info`  Reference
        ^^^^^^^^^
        CLI and Python API