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.6)
  • 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

💻 ⚠️ 📖

Brian Gerwe

💻 ⚠️ 📖 👀

Neal

👀 💻

Matt Murbach

📖 👀 ⚠️ 💻

Kenny Huynh

🐛 💻

lawrencerenna

🤔

Rowin

🐛 💻

Michael Plews

🤔

Chebuskin

🐛

environmat

🐛

Abdullah Sumbal

🐛

nobkat

💻

Nick

🐛 💻

aokomorowski

💻

Peter Attia

💻 ⚠️ 📖

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.2.2.tar.gz (43.0 kB view details)

Uploaded Source

Built Distribution

impedance-1.2.2-py3-none-any.whl (45.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: impedance-1.2.2.tar.gz
  • Upload date:
  • Size: 43.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200925 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.6.8

File hashes

Hashes for impedance-1.2.2.tar.gz
Algorithm Hash digest
SHA256 83a8721b65b223a6f62aae578b087a86458ea6eba2662075175dac3fe51a34bc
MD5 485fcb000e33d7eff30757f0e45618fa
BLAKE2b-256 516d39a4ee473531803944512d96772c928e578ca87de9fd3825e8290b3375d3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: impedance-1.2.2-py3-none-any.whl
  • Upload date:
  • Size: 45.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200925 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.6.8

File hashes

Hashes for impedance-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a5e3ba9cac2e6fe3f189e50f4c6992ed88442bfc75421d5d45c0ab6fe24cc323
MD5 72efa79b73ff36c106f2c8f7257fce57
BLAKE2b-256 66dde557ce0ad876c579f8bc0469ca20f1ec637a325a5c94ae8ed527ed490bdb

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