Skip to main content

A Python package for working with impedance data

Project description

GitHub release PyPI - Downloads

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 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!

impedance.py currently provides:

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

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

Uploaded Source

Built Distribution

impedance-0.4.0-py3-none-any.whl (24.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for impedance-0.4.0.tar.gz
Algorithm Hash digest
SHA256 7ed38814da553d778539f89eb967d6cc9f4244da73e7c56f3c0cae9fabaf5dbb
MD5 1ff4109e563c7a28bc446a61e24110e9
BLAKE2b-256 71748655e16ca3b7084d73b42da95e6f140bf9d9b1554eeccbf56d2295f07053

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for impedance-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a92e713d603adf85d219f2eab15147c275c9543aa66974c059bee3d2187571d5
MD5 a94566fb3200c007b826ddcf4b4fbd79
BLAKE2b-256 8be487ccd98102a734ac841ef00bd4744762a2ff43845a7d4d4d82852443ad83

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