Skip to content

ECSHackWeek/impedance.py

Repository files navigation

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!