Impedance Agent
==========================================

A Python package for automated impedance spectroscopy analysis combining traditional methods with AI assistance.

.. toctree::
   :maxdepth: 2
   :caption: User Guide:

   installation
   usage
   examples/index

.. toctree::
   :maxdepth: 2
   :caption: Technical Documentation:

   technical_implementations
   modules

Features
========

Analysis Capabilities
---------------------
* Automated EIS data analysis with multiple validation methods
* Kramers-Kronig compliance testing using LinKK analysis
* Equivalent Circuit Model (ECM) fitting with comprehensive metrics
* Distribution of Relaxation Times (DRT) analysis
* Path following and vector difference analysis
* Parameter correlation and uncertainty quantification

Model Support
-------------
* Multiple equivalent circuit models
* Custom model definition support
* Bounded parameter optimization
* Multiple weighting schemes for fitting

AI Integration
--------------
* LLM-guided analysis workflow
* Automated interpretation of results
* Physical meaning extraction
* Model improvement recommendations

Quality Metrics
---------------
* Comprehensive fit quality assessment
* Path following analysis
* Vector difference analysis
* Parameter correlation analysis
* Akaike Information Criterion (AIC)
* Residual analysis

Data Formats
------------
* Support for common impedance data formats
* Flexible data import capabilities
* Result export in multiple formats
* Publication-ready plotting

Getting Started
===============

See the :doc:`installation` guide to get started with Impedance Agent, then follow the :doc:`usage` guide for basic usage examples.

For detailed examples and use cases, check the :doc:`examples/index` section.

Technical Details
=================

For in-depth technical information about the implementations and algorithms, see :doc:`technical_implementations`.

API documentation can be found in the :doc:`modules` section.

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

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