Examples
========

Learn how to use the `nibcq` package in various battery cell quality testing scenarios. 
Each example includes a brief description and a corresponding code snippet.

Configuration and Support Files
-------------------------------

The following examples use JSON files.
Use these files to create a portable configuration.

ACIR Test Parameters Configuration File
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This example file holds ACIR test parameters.

.. literalinclude:: ../examples/resources/ACIRConfigFile.json
   :language: json
   :linenos:

EIS Test Parameters Configuration File
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This example file holds EIS test parameters.

.. literalinclude:: ../examples/resources/EISConfigFile.json
   :language: json
   :linenos:

OCV Test Parameters Configuration File
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This example file holds OCV test parameters.

.. literalinclude:: ../examples/resources/OCVConfigFile.json
   :language: json
   :linenos:

SMU Switching Configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^

This switch configuration file is used by SMU-based measurement (ACIR, EIS) examples. These examples include sourcing and sensing
switch resources.

.. literalinclude:: ../examples/resources/SMUSwitchConfig.json
   :language: json
   :linenos:

DMM switching configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^

This switch configuration file is used by DMM-based measurement (OCV) examples. These examples include sensing switch resources.

.. literalinclude:: ../examples/resources/DMMSwitchConfig.json
   :language: json
   :linenos:

Known Impedance Table (KIT) file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

KIT files are used by the compensation-with-kit examples.
This file provides short impedance values of a known resistor. These values are then used to create a short compensation file.
The KIT file values are subtracted when creating the compensation file. As such, the compensation file only records the impedance of the jig.

.. literalinclude:: ../examples/resources/KIT_Short_2mOhm.json
   :language: json
   :linenos:


ACIR Examples
-------------

ACIR Compensation File creation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/acir_create_compensation_file.py

.. literalinclude:: ../examples/acir_create_compensation_file.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

ACIR Compensation File Creation with Known Impedance Table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/acir_create_compensation_with_kit.py

.. literalinclude:: ../examples/acir_create_compensation_with_kit.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

Simple ACIR Measurement
^^^^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/acir_simple.py

.. literalinclude:: ../examples/acir_simple.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

ACIR with Raw Data Saving
^^^^^^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/acir_with_raw_data_saving.py

.. literalinclude:: ../examples/acir_with_raw_data_saving.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

ACIR with Temperature Measurement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/acir_with_temperature.py

.. literalinclude:: ../examples/acir_with_temperature.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

ACIR with Switching
^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/acir_with_switching.py

.. literalinclude:: ../examples/acir_with_switching.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

ACIR with Switching and Temperature Measurement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/acir_with_switching_and_temperature.py

.. literalinclude:: ../examples/acir_with_switching_and_temperature.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

DCIR Examples
-------------

Simple DCIR Measurement
^^^^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/dcir_simple.py

.. literalinclude:: ../examples/dcir_simple.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

DCIR with Raw Data Saving
^^^^^^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/dcir_with_raw_data_saving.py

.. literalinclude:: ../examples/dcir_with_raw_data_saving.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

EIS examples
------------

EIS Compensation File creation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/eis_create_compensation_file.py

.. literalinclude:: ../examples/eis_create_compensation_file.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

EIS Compensation File Creation with Known Impedance Table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/eis_create_compensation_with_kit.py

.. literalinclude:: ../examples/eis_create_compensation_with_kit.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

Simple EIS Measurement
^^^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/eis_simple.py

.. literalinclude:: ../examples/eis_simple.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

EIS with Measurement Data Saving
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/eis_with_raw_data_saving.py

.. literalinclude:: ../examples/eis_with_raw_data_saving.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

EIS with Temperature Measurement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/eis_with_temperature.py

.. literalinclude:: ../examples/eis_with_temperature.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

EIS with Switching
^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/eis_with_switching.py

.. literalinclude:: ../examples/eis_with_switching.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

EIS with Switching and Temperature Measurement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/eis_with_switching_and_temperature.py

.. literalinclude:: ../examples/eis_with_switching_and_temperature.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

OCV examples
------------

Simple OCV Measurement
^^^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/ocv_simple.py

.. literalinclude:: ../examples/ocv_simple.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

OCV with Switching
^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/ocv_with_switching.py

.. literalinclude:: ../examples/ocv_with_switching.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

OCV with Measurement Data Saving
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/ocv_with_raw_data_saving.py

.. literalinclude:: ../examples/ocv_with_raw_data_saving.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

Other Utilities and Simulated Devices
-------------------------------------

Run Self Calibration
^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/self_calibration_run.py

.. literalinclude:: ../examples/self_calibration_run.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

Simulated DMM Device
^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/simulated_dmm_device.py

.. literalinclude:: ../examples/simulated_dmm_device.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent:

Simulated SMU Device
^^^^^^^^^^^^^^^^^^^^

.. example-docstring:: ../examples/simulated_smu_device.py

.. literalinclude:: ../examples/simulated_smu_device.py
   :language: python
   :start-after: # example-main-start
   :end-before: # example-main-end
   :dedent: