Skip to main content

A Python package for working with impedance data

Project description

Build Status

Coverage Status

Documentation 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 using pip:

pip install impedance

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

impedance-0.2.0-py3-none-any.whl (23.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: impedance-0.2.0.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.5

File hashes

Hashes for impedance-0.2.0.tar.gz
Algorithm Hash digest
SHA256 e44f28a5b8c1777578d05ebd08c21f6994ef0794c243263eb1b233d40053ede1
MD5 b72aaf67ce0050f39fdc30115c812c88
BLAKE2b-256 0cb2c85a33ed0f6aea69c14457cd7d1cd1559cf8aaf8f0459640391ee217effe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: impedance-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 23.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.5

File hashes

Hashes for impedance-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fbee06b61e99a2b3af1ae40468d58ce64f84b4528544181207ba60aec1ba34e8
MD5 70e6de233e84adaeaed7f33d30c45110
BLAKE2b-256 b8ffb589be96fac3dae2ca4ac26930ddbb7a64e5553c2ae986d782dbbfe12519

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page