impedance.py¶
impedance.py is a Python module for working with impedance data.
This project started at the 2018 Electrochemical Society (ECS) Hack Week and has grown from there.
Using a scikit-learn-like API, we hope to make visualizing, fitting, and analyzing impedance spectra more intuitive and reproducible.
Note
impedance.py is currently in a beta phase and new features are rapidly being added.
If you have a feature request or find a bug, please feel free to 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!
User Installation¶
The easiest way to install impedance.py is from PyPI using pip:
pip install impedance
Dependencies¶
impedance.py requires:
- Python (>=3.5)
- SciPy (>=1.0)
- NumPy (>=1.14)
- Matplotlib (>=3.0)
Several example notebooks are provided in the examples/ directory.
Opening these will also require Jupyter Notebook or Jupyter Lab.
Examples and Documentation¶
Getting started with impedance.py contains a detailed walk
through of how to get started from scratch. If you’re already familiar with
Jupyter/Python, several examples can be found in the examples/ directory
(the fitting_tutorial.ipynb
is a great place to start) and the documentation can be found at
impedancepy.readthedocs.io.