Skip to main content

A package for analyzing electrochemical impedance data

Project description

DOI GitHub release

PyPI - Downloads All Contributors

Build Status Documentation Status Coverage Status

impedance.py

impedance.py is a Python package for making electrochemical impedance spectroscopy (EIS) analysis reproducible and easy-to-use.

Aiming to create a consistent, scikit-learn-like API for impedance analysis, impedance.py contains modules for data preprocessing, validation, model fitting, and visualization.

For a little more in-depth discussion of the package background and capabilities, check out our Journal of Open Source Software paper.

If you have a feature request or find a bug, please file an issue or, better yet, make the code improvements and submit a pull request! The goal is to build an open-source tool that the entire impedance community can improve and use!

Installation

The easiest way to install impedance.py is from PyPI using pip.

pip install impedance

See Getting started with impedance.py for instructions on getting started from scratch.

Dependencies

impedance.py requires:

  • Python (>=3.7)
  • SciPy (>=1.0)
  • NumPy (>=1.14)
  • Matplotlib (>=3.0)
  • Altair (>=3.0)

Several example notebooks are provided in the docs/source/examples/ directory. Opening these will require Jupyter notebook or Jupyter lab.

Examples and Documentation

Several examples can be found in the docs/source/examples/ directory (the Fitting impedance spectra notebook is a great place to start) and the documentation can be found at impedancepy.readthedocs.io.

Citing impedance.py

DOI

If you use impedance.py in published work, please consider citing https://joss.theoj.org/papers/10.21105/joss.02349 as

@article{Murbach2020,
  doi = {10.21105/joss.02349},
  url = {https://doi.org/10.21105/joss.02349},
  year = {2020},
  publisher = {The Open Journal},
  volume = {5},
  number = {52},
  pages = {2349},
  author = {Matthew D. Murbach and Brian Gerwe and Neal Dawson-Elli and Lok-kun Tsui},
  title = {impedance.py: A Python package for electrochemical impedance analysis},
  journal = {Journal of Open Source Software}
}

Contributors ✨

This project started at the 2018 Electrochemical Society (ECS) Hack Week in Seattle and has benefited from a community of users and contributors since. Thanks goes to these wonderful people (emoji key):

Lok-kun Tsui
Lok-kun Tsui

💻 ⚠️ 📖
Brian Gerwe
Brian Gerwe

💻 ⚠️ 📖 👀
Neal
Neal

👀 💻
Matt Murbach
Matt Murbach

📖 👀 ⚠️ 💻
Kenny Huynh
Kenny Huynh

🐛 💻
lawrencerenna
lawrencerenna

🤔
Rowin
Rowin

🐛 💻
Michael Plews
Michael Plews

🤔
Chebuskin
Chebuskin

🐛
environmat
environmat

🐛
Abdullah Sumbal
Abdullah Sumbal

🐛
nobkat
nobkat

💻
Nick
Nick

🐛 💻
aokomorowski
aokomorowski

💻
Peter Attia
Peter Attia

💻 ⚠️ 📖
sdkang
sdkang

⚠️ 💻
lucasfdvx
lucasfdvx

🐛
Marcus Karlstad
Marcus Karlstad

🐛
Mark Bouman
Mark Bouman

🐛 💻
oslopanda
oslopanda

🐛
pililac
pililac

🐛
Kavin Teenakul
Kavin Teenakul

💻 📖
Enrico
Enrico

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

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

impedance-1.7.1.tar.gz (47.1 kB view details)

Uploaded Source

Built Distribution

impedance-1.7.1-py3-none-any.whl (48.4 kB view details)

Uploaded Python 3

File details

Details for the file impedance-1.7.1.tar.gz.

File metadata

  • Download URL: impedance-1.7.1.tar.gz
  • Upload date:
  • Size: 47.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for impedance-1.7.1.tar.gz
Algorithm Hash digest
SHA256 c0523b8cb5073119bb32f61652445f49f07e9277dc8f62ffa35da7781fd8af73
MD5 a053a5b30104f24d71e1c2a8156cb4f1
BLAKE2b-256 faed13dd1d71e97c21eed9b1792a4d642597199a11eb619cb632218bbbd3009c

See more details on using hashes here.

File details

Details for the file impedance-1.7.1-py3-none-any.whl.

File metadata

  • Download URL: impedance-1.7.1-py3-none-any.whl
  • Upload date:
  • Size: 48.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for impedance-1.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 aeaf2208377bd4e0ea9a8eca557df784759ff794599cd56cdc68cc1fe4218fe6
MD5 e2156cbec89952d29b46e4fb2af8c4f6
BLAKE2b-256 5ca97aba8b417222813c1fc1b73c742bf9abf0bf2da2c8edb11ba57d331f3017

See more details on using hashes here.

Supported by

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