Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ECSHackWeek/impedance.py

A Python package for working with electrochemical impedance data
https://github.com/ECSHackWeek/impedance.py

battery corrosion electrochemistry fuel-cell impedance lithium-ion

Last synced: about 2 months ago
JSON representation

A Python package for working with electrochemical impedance data

Host: GitHub
URL: https://github.com/ECSHackWeek/impedance.py
Owner: ECSHackWeek
License: mit
Created: 2018-06-05T02:49:41.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2023-07-16T17:31:09.000Z (about 1 year ago)
Last Synced: 2024-06-11T17:42:48.601Z (3 months ago)
Topics: battery, corrosion, electrochemistry, fuel-cell, impedance, lithium-ion
Language: Python
Homepage:
Size: 5.79 MB
Stars: 196
Watchers: 22
Forks: 100
Open Issues: 43
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff

Awesome Lists containing this project

open-sustainable-technology - impedance.py - A Python package for working with electro-chemical impedance data. (Energy Storage / Battery)

README

        [![DOI](https://zenodo.org/badge/136110609.svg)](https://zenodo.org/badge/latestdoi/136110609)  ![GitHub release](https://img.shields.io/github/release/ECSHackWeek/impedance.py)

![PyPI - Downloads](https://img.shields.io/pypi/dm/impedance?style=flat-square)  [![All Contributors](https://img.shields.io/badge/all_contributors-11-orange.svg?style=flat-square)](#contributors)

[![Build Status](https://travis-ci.org/ECSHackWeek/impedance.py.svg?branch=master&kill_cache=1)](https://travis-ci.org/ECSHackWeek/impedance.py)  [![Documentation Status](https://readthedocs.org/projects/impedancepy/badge/?version=latest&kill_cache=1)](https://impedancepy.readthedocs.io/en/latest/?badge=latest) [![Coverage Status](https://coveralls.io/repos/github/ECSHackWeek/impedance.py/badge.svg?branch=master&kill_cache=1)](https://coveralls.io/github/ECSHackWeek/impedance.py?branch=master)

impedance.py

------------

`impedance.py` is a Python package for making electrochemical impedance spectroscopy (EIS) analysis reproducible and easy-to-use.

Aiming to create a consistent, [scikit-learn-like API](https://arxiv.org/abs/1309.0238) for impedance analysis, impedance.py contains modules for data preprocessing, validation, model fitting, and visualization.

For a little more in-depth discussion of the package background and capabilities, check out our [Journal of Open Source Software paper](https://joss.theoj.org/papers/10.21105/joss.02349).

If you have a feature request or find a bug, please [file an issue](https://github.com/ECSHackWeek/impedance.py/issues) or, better yet, make the code improvements and [submit a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)! The goal is to build an open-source tool that the entire impedance community can improve and use!

### Installation

The easiest way to install impedance.py is from [PyPI](https://pypi.org/project/impedance/) using pip.

```bash

pip install impedance

```

See [Getting started with impedance.py](https://impedancepy.readthedocs.io/en/latest/getting-started.html) for instructions on getting started from scratch.

#### Dependencies

impedance.py requires:

-   Python (>=3.7)

-   SciPy (>=1.0)

-   NumPy (>=1.14)

-   Matplotlib (>=3.0)

-   Altair (>=3.0)

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

#### Examples and Documentation

Several examples can be found in the `docs/source/examples/` directory (the [Fitting impedance spectra notebook](https://impedancepy.readthedocs.io/en/latest/examples/fitting_example.html) is a great place to start) and the documentation can be found at [impedancepy.readthedocs.io](https://impedancepy.readthedocs.io/en/latest/).

## Citing impedance.py

[![DOI](https://joss.theoj.org/papers/10.21105/joss.02349/status.svg)](https://doi.org/10.21105/joss.02349)

If you use impedance.py in published work, please consider citing https://joss.theoj.org/papers/10.21105/joss.02349 as

```bash

@article{Murbach2020,

  doi = {10.21105/joss.02349},

  url = {https://doi.org/10.21105/joss.02349},

  year = {2020},

  publisher = {The Open Journal},

  volume = {5},

  number = {52},

  pages = {2349},

  author = {Matthew D. Murbach and Brian Gerwe and Neal Dawson-Elli and Lok-kun Tsui},

  title = {impedance.py: A Python package for electrochemical impedance analysis},

  journal = {Journal of Open Source Software}

}

```

## Contributors ✨

This project started at the [2018 Electrochemical Society (ECS) Hack Week in Seattle](https://www.electrochem.org/233/hack-week) and has benefited from a community of users and contributors since. Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
_{Lok-kun Tsui}
💻 ⚠️ 📖

      
_{Brian Gerwe}
💻 ⚠️ 📖 👀

      
_Neal
👀 💻

      
_{Matt Murbach}
📖 👀 ⚠️ 💻

      
_{Kenny Huynh}
🐛 💻

      
_{lawrencerenna}
🤔

      
_Rowin
🐛 💻

    

    

      
_{Michael Plews}
🤔

      
_Chebuskin
🐛

      
_environmat
🐛

      
_{Abdullah Sumbal}
🐛

      
_nobkat
💻

      
_Nick
🐛 💻

      
_aokomorowski
💻

    

    

      
_{Peter Attia}
💻 ⚠️ 📖

      
_sdkang
⚠️ 💻

      
_lucasfdvx
🐛

      
_{Marcus Karlstad}
🐛

      
_{Mark Bouman}
🐛 💻

      
_oslopanda
🐛

      
_pililac
🐛

    

    

      
_{Kavin Teenakul}
💻 📖

      
_Enrico
💻

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!