.. AutoEIS documentation master file, created by
   sphinx-quickstart on Tue Oct 10 07:17:41 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. _front_page:

.. module:: autoeis
   :noindex:

###############################
AutoEIS: Automated EIS Analysis
###############################

What is AutoEIS?
################

AutoEIS is a Python package that automatically proposes statistically plausible equivalent circuit models (ECMs) for electrochemical impedance spectroscopy (EIS) analysis. The package is designed for researchers and practitioners in the fields of electrochemical analysis, including but not limited to explorations of electrocatalysis, battery design, and investigations of material degradation.

AutoEIS is still under development and therefore, the API is still not stable. If you find any bugs or have any suggestions, please file an `issue <https://github.com/AUTODIAL/AutoEIS/issues>`_ or directly submit a `pull request <https://github.com/AUTODIAL/AutoEIS/pulls>`_. We would greatly appreciate any contributions from the community.

.. figure:: ../assets/workflow.png
   :name: banner
   :align: center

   Typical workflow of AutoEIS

.. Contents
.. ########

.. toctree::
   :hidden:
   :maxdepth: 1

   installation.md
   basic_usage.md
   circuit.md
   examples
   modules.rst