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 the alpha 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
  • equivalent circuit fitting with customizable models
  • convenient Nyquist plots including confidence interval estimation for fit circuits

several features are currently being improved upon:

  • implementation of measurement models as a data validation method
  • interactive plotting with altair
  • adding more impedance elements
  • physics-based impedance models for lithium-ion batteries

Installation

Dependencies

impedance.py requires:

  • Python (>=3.5)
  • SciPy (>=1.0)
  • NumPy (>=1.14)
  • Matplotlib (>=2.2)

Several example notebooks are provided in the examples/jupyter directory. Opening these will require Jupyter notebook or Jupyter lab.

User Installation

If you already have a working installation of numpy, scipy, and matplotlib, the easiest way to install impedance.py is using pip:

pip install -U impedance

Examples and Documentation

Several examples can be found in the examples/ directory 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.1.1a0.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

impedance-0.1.1a0-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

Details for the file impedance-0.1.1a0.tar.gz.

File metadata

  • Download URL: impedance-0.1.1a0.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for impedance-0.1.1a0.tar.gz
Algorithm Hash digest
SHA256 8ac33742b3e59b6c07ef1d5504d0b03479e2f2231c42db861011dd93fb40f7ea
MD5 1e724761585a0c306f7ebd3213e45d2c
BLAKE2b-256 16404c0ba77f8bf29aada806fe5fbf8aee196df11258ded45e954d0903eaef37

See more details on using hashes here.

File details

Details for the file impedance-0.1.1a0-py3-none-any.whl.

File metadata

File hashes

Hashes for impedance-0.1.1a0-py3-none-any.whl
Algorithm Hash digest
SHA256 36f62d0e6f1eec36afb3963835b92fab647da22211e7c612eeb5f5c5ec5aaecd
MD5 76b02199d89a7d81bd38607f68579544
BLAKE2b-256 7b04ba71ef6c695e13f7bd3c4bfbecb37e49757b665a77ca4c488efb7c881a6c

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