.. bdat documentation master file, created by
   sphinx-quickstart on Thu Oct  3 23:01:24 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to bdat's documentation!
================================

.. image:: images/bdat_structure.svg

The Battery Data Analysis Toolkit (bdat) provides a set of functions that enable the import and analysis of electrical battery data.
It is designed to interact with a `Kadi4Mat <https://kadi.iam.kit.edu/>`__ instance, but can also be used as a standalone tool.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   setup
   cli
   structure
   kadi
   examples

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`