Skip to main content

A tool for automated EIS analysis by proposing statistically plausible ECMs.

Project description

example workflow

[!TIP] Want to get notified about major announcements/new features? Please click on "Watch" -> "Custom" -> Check "Releases". Starring the repository alone won't notify you when we make a new release. This is particularly useful since we're actively working on adding new features/improvements to AutoEIS. Currently, we might issue a new release every month, so rest assured that you won't be spammed.

AutoEIS

What is AutoEIS?

AutoEIS (Auto ee-eye-ess) 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 the API might change. If you find any bugs or have any suggestions, please file an issue or directly submit a pull request. We would greatly appreciate any contributions from the community.

Installation

Pip

Open a terminal (or command prompt on Windows) and run the following command:

pip install -U autoeis

Julia dependencies will be automatically installed at first import. It's recommended that you have your own Julia installation, but if you don't, Julia itself will also be installed automatically.

How to install Julia? If you decided to have your own Julia installation (recommended), the official way to install Julia is via juliaup. Juliaup provides a command line interface to automatically install Julia (optionally multiple versions side by side). Working with juliaup is straightforward; Please follow the instructions on its GitHub page.

Usage

Visit our examples' page to learn how to use AutoEIS.

Workflow

The schematic workflow of AutoEIS is shown below:

AutoEIS workflow

It includes: data pre-processing, ECM generation, circuit post-filtering, Bayesian inference, and the model evaluation process. Through this workflow, AutoEis can prioritize the statistically optimal ECM and also retain suboptimal models with lower priority for subsequent expert inspection. A detailed workflow can be found in the paper.

Acknowledgement

Thanks to Prof. Jason Hattrick-Simpers, Dr. Robert Black, Dr. Debashish Sur, Dr. Parisa Karimi, Dr. Brian DeCost, Dr. Kangming Li, and Prof. John R. Scully for their guidance and support. Also, thanks to Dr. Shijing Sun, Prof. Keryn Lian, Dr. Alvin Virya, Dr. Austin McDannald, Dr. Fuzhan Rahmanian, and Prof. Helge Stein for their feedback and discussions. Special shoutout to Prof. John R. Scully and Dr. Debashish Sur for letting us use their corrosion data to showcase the functionality of AutoEIS—your help has been invaluable!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autoeis-0.0.35.tar.gz (178.8 kB view details)

Uploaded Source

Built Distribution

autoeis-0.0.35-py3-none-any.whl (182.2 kB view details)

Uploaded Python 3

File details

Details for the file autoeis-0.0.35.tar.gz.

File metadata

  • Download URL: autoeis-0.0.35.tar.gz
  • Upload date:
  • Size: 178.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.2

File hashes

Hashes for autoeis-0.0.35.tar.gz
Algorithm Hash digest
SHA256 9c3ec32650ec9a215195f95fc93e296e433c2c2342cc45e2777310dbea842d23
MD5 a150c28793176c055d2cf3031492719c
BLAKE2b-256 4f1de1b77aa5b070663a20555f37152fa9380912cfcf979c3bd806da27414798

See more details on using hashes here.

File details

Details for the file autoeis-0.0.35-py3-none-any.whl.

File metadata

  • Download URL: autoeis-0.0.35-py3-none-any.whl
  • Upload date:
  • Size: 182.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.2

File hashes

Hashes for autoeis-0.0.35-py3-none-any.whl
Algorithm Hash digest
SHA256 73db47c5465d0e50bb2f3f31098c23ee12738ca5154629ba43bfebe06d22918e
MD5 90f0bb13bb51fc708e30c5de5edbd2e1
BLAKE2b-256 f4fd7497f372fe6977130ccaf3a09aade23543b7ab175d83a4f743241c594f0d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page