Skip to main content

A Python package for working with impedance data

Project description

GitHub release PyPI - Downloads All Contributors

Build Status Documentation Status

Codacy Badge Coverage Status

impedance.py

impedance.py is a Python module for working with impedance data.

This project started at the 2018 Electrochemical Society (ECS) Hack Week in Seattle 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.

impedance.py is currently under development 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!

impedance.py currently provides:

  • preprocessing functions for easily loading in impedance data from a wide variety of file types
  • a simple API for fitting, predicting, and plotting impedance
  • validation methods for checking measurement validity
  • equivalent circuit fitting with customizable models
  • convenient Nyquist plots including confidence interval estimation for fit circuits

several features are currently being improved upon:

  • interactive plotting with altair
  • physics-based impedance models for lithium-ion batteries

Installation

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 require Jupyter notebook or Jupyter lab.

User Installation

The easiest way to install impedance.py is from PyPI using pip (see Getting started with impedance.py for instructions).

Examples and Documentation

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.

Contributors ✨

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

💻

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

Uploaded Source

Built Distributions

impedance-0.5.1-py3.6.egg (79.3 kB view details)

Uploaded Egg

impedance-0.5.1-py3-none-any.whl (31.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: impedance-0.5.1.tar.gz
  • Upload date:
  • Size: 28.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.1 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for impedance-0.5.1.tar.gz
Algorithm Hash digest
SHA256 cb39734656885e7992dd110383904bbb3bf9678fd1352adc91410f7e31532109
MD5 7a8f6547b9058d7edb642c7d4759812b
BLAKE2b-256 5ff5a4c662e3d29c758facb00ccb249562050f219147e118de7f64e007cc2312

See more details on using hashes here.

File details

Details for the file impedance-0.5.1-py3.6.egg.

File metadata

  • Download URL: impedance-0.5.1-py3.6.egg
  • Upload date:
  • Size: 79.3 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.8

File hashes

Hashes for impedance-0.5.1-py3.6.egg
Algorithm Hash digest
SHA256 9ef12360e65b30558e5970468c452913925e5ef335648f0c999a47135ea5416f
MD5 ed7aa2cb488fbc2b1dde1a25f0b37b60
BLAKE2b-256 b3eeb143619e4051f96bc7ec3560fbb9c0a7e46156fe106739d4b621677f8f06

See more details on using hashes here.

File details

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

File metadata

  • Download URL: impedance-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 31.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.1 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for impedance-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dcbca6ccd44428eea8e51d641b260d13f4ddf04030d87567378cc9886e5d9d98
MD5 f1fd391c5b9c037a3f9028ed34663e4e
BLAKE2b-256 fec39bb6b220af0c808878fa6fe2b69b50a239ccb85b7de15dd7f053ea0d1723

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