================================================
NI Battery Cell Quality Python API Documentation
================================================

About
=====

The **nibcq** module provides a Python API for performing battery cell characterization measurements using National Instruments hardware. It provides high-level APIs for Electrochemical Impedance Spectroscopy (EIS), AC Internal Resistance (ACIR), DC Internal Resistance (DCIR), and Open Circuit Voltage (OCV) testing.

The code is maintained in the `nibcq-python repository <https://github.com/ni/nibcq-python>`_.

Support Policy
--------------

nibcq supports all Operating Systems supported by the NI Battery Cell Quality Toolkit drivers (NI-DCPower, NI-DMM, NI-Switch, NI-DAQmx).

It follows `Python Software Foundation <https://devguide.python.org/#status-of-python-branches>`_ support policy for different versions of CPython, starting from 3.12. Python 3.12 or later is required.

.. note::
   NI created and supports nibcq.

----

Contributing
============

**At this time, we are not accepting external contributions to this project.**

The nibcq library is currently in active internal development at National Instruments. While we appreciate the community's interest, we are not set up to handle external pull requests, issues, or contributions at this time. This policy may change in the future.

----

Support / Feedback
==================

For support with hardware, the driver runtime, or any other questions related to NI Battery Cell Quality Toolkit, please visit `NI Support <https://www.ni.com/support>`_ or `NI Community Forums <https://forums.ni.com/>`_.

----

Bugs / Feature Requests
=======================

While we are not currently accepting contributions, you may report bugs or request features through `NI Support <https://www.ni.com/support>`_.

----

Documentation
=============

.. toctree::
   :maxdepth: 4
   :caption: nibcq Module

   autoapi/index
   changelog

.. toctree::
   :maxdepth: 2
   :caption: Examples

   examples

----

Additional Documentation
========================

Refer to your driver documentation for device-specific information and detailed API documentation:

- `NI-DCPower Documentation <https://www.ni.com/docs/en-US/bundle/ni-dcpower/>`_
- `NI-DMM Documentation <https://www.ni.com/docs/en-US/bundle/ni-dmm/>`_
- `NI-Switch Documentation <https://www.ni.com/docs/en-US/bundle/ni-switch/>`_
- `NI-DAQmx Documentation <https://www.ni.com/docs/en-US/bundle/ni-daqmx/>`_
- `Battery Cell Quality Toolkit Manual <https://www.ni.com/docs/en-US/bundle/battery-cell-quality-toolkit>`_

----

License
=======

nibcq-python is licensed under an MIT-style license (see `LICENSE <https://github.com/ni/nibcq-python/blob/main/LICENSE>`_). All licenses allow for non-commercial and commercial use.

For third-party software notices and license information, see the `NOTICE <https://github.com/ni/nibcq-python/blob/main/NOTICE>`_ file.

----

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

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