Skip to main content

A Python package for working with impedance data

Project description

Build Status

Coverage Status

Documentation Status

Codacy Badge

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

Uploaded Source

Built Distribution

impedance-0.3.0-py3-none-any.whl (23.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: impedance-0.3.0.tar.gz
  • Upload date:
  • Size: 20.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.8

File hashes

Hashes for impedance-0.3.0.tar.gz
Algorithm Hash digest
SHA256 152774363efce88e0c60e62da8f11eedb59822e025c409f556489691c8b03a1e
MD5 ce41368b0100725c75e821cb2b41d7c1
BLAKE2b-256 5432fc6731331493845def43aa9c4aca4f6aa92ef68672aa589b11bc0423f5cd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: impedance-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 23.6 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.8

File hashes

Hashes for impedance-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5c4928983cd43109fe5e78b59a51042a701e2228965a557f438bc18a60384506
MD5 f2c09df8dc183d0b6dd2c57dd56f6a1a
BLAKE2b-256 ffd75fe8e85ca8ab17c7ddc1e24b342e8a366d66a4a2b57d0e7dd2f693842079

See more details on using hashes here.

Supported by

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