impedance.py
A Python package for working with electro-chemical impedance data.
https://github.com/ECSHackWeek/impedance.py
Category: Energy Storage
Sub Category: Battery
Keywords
battery corrosion electrochemistry fuel-cell impedance lithium-ion
Keywords from Contributors
simulator batteries composer unitful
Last synced: about 13 hours ago
JSON representation
Repository metadata
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 (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T03:35:41.000Z (8 months ago)
- Last Synced: 2025-04-14T16:43:59.411Z (13 days ago)
- Topics: battery, corrosion, electrochemistry, fuel-cell, impedance, lithium-ion
- Language: Python
- Homepage:
- Size: 5.8 MB
- Stars: 237
- Watchers: 21
- Forks: 109
- Open Issues: 53
- Releases: 21
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
README.md
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 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.
If you have a feature request or find a bug, please 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!
Installation
The easiest way to install impedance.py is from PyPI using pip.
pip install impedance
See Getting started with impedance.py for instructions on getting started from scratch.
Dependencies
impedance.py requires:
- Python (>=3.7)
- SciPy (>=1.0)
- NumPy (>=1.22.4)
- Matplotlib (>=3.0)
- Altair (>=3.0)
- Pandas
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 is a great place to start) and the documentation can be found at impedancepy.readthedocs.io.
Citing impedance.py
If you use impedance.py in published work, please consider citing https://joss.theoj.org/papers/10.21105/joss.02349 as
@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 and has benefited from a community of users and contributors since. Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use impedance.py in published work, please consider citing https://joss.theoj.org/papers/10.21105/joss.02349 as shown below" preferred-citation: type: article 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 authors: - family-names: Murbach given-names: Matthew orcid: http://orcid.org/0000-0002-6583-5995 - family-names: Gerwe given-names: Brian orcid: http://orcid.org/0000-0002-1184-8483 - family-names: Dawson-Elli given-names: Neal orcid: http://orcid.org/0000-0003-4559-7309 - family-names: Tsui given-names: Lok-kun orcid: http://orcid.org/0000-0001-7381-0686 title: "impedance.py: A Python package for electrochemical impedance analysis" journal: Journal of Open Source Software
Owner metadata
- Name: ECS Hack Week
- Login: ECSHackWeek
- Email:
- Kind: organization
- Description:
- Website:
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/32744210?v=4
- Repositories: 7
- Last ynced at: 2023-03-02T05:26:29.328Z
- Profile URL: https://github.com/ECSHackWeek
GitHub Events
Total
- Issues event: 4
- Watch event: 22
- Issue comment event: 1
- Pull request event: 1
- Fork event: 9
Last Year
- Issues event: 4
- Watch event: 22
- Issue comment event: 1
- Pull request event: 1
- Fork event: 9
Committers metadata
Last synced: 5 days ago
Total Commits: 486
Total Committers: 26
Avg Commits per committer: 18.692
Development Distribution Score (DDS): 0.523
Commits in past year: 6
Committers in past year: 3
Avg Commits per committer in past year: 2.0
Development Distribution Score (DDS) in past year: 0.333
Name | Commits | |
---|---|---|
Matt Murbach | m****h@u****u | 232 |
Brian Gerwe | g****b@u****u | 53 |
Lok-kun Tsui | l****i@u****u | 40 |
allcontributors[bot] | 4****] | 37 |
Peter Attia | p****a@g****m | 27 |
Neal Dawson-Elli | n****e@u****u | 25 |
Kenny Huynh | h****v@g****m | 15 |
Dave Beck | d****b@u****u | 12 |
Jason Bonezzi | j****5@z****u | 10 |
Nick | n****y@g****m | 7 |
pangq2 | p****q@o****u | 6 |
Neal Dawson-Elli | n****i@p****m | 5 |
Kavin Teenakul | a****t@p****m | 2 |
Marcus Karlstad | 9****i | 2 |
Rowin | r****n@a****r | 2 |
Adrian Usler | 4****r | 1 |
Mark Bouman | 1****n | 1 |
Matthew Evans | 7****s | 1 |
Raymond Gasper | 1****r | 1 |
Simon Timbillah | s****h@m****u | 1 |
aokomorowski | 4****i | 1 |
nobkat | n****9@g****m | 1 |
oslopanda | 3****a | 1 |
pililac | 6****c | 1 |
sdkang | 5****g | 1 |
Enrico | e****l@g****m | 1 |
Committer domains:
- uw.edu: 4
- mtech.edu: 1
- anhydride-acide.fr: 1
- payscale.com: 1
- oregonstate.edu: 1
- zips.uakron.edu: 1
- unm.edu: 1
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 151
Total pull requests: 162
Average time to close issues: 3 months
Average time to close pull requests: 26 days
Total issue authors: 85
Total pull request authors: 31
Average comments per issue: 2.5
Average comments per pull request: 1.94
Merged pull request: 140
Bot issues: 0
Bot pull requests: 32
Past year issues: 10
Past year pull requests: 17
Past year average time to close issues: 18 days
Past year average time to close pull requests: 4 days
Past year issue authors: 10
Past year pull request authors: 8
Past year average comments per issue: 0.1
Past year average comments per pull request: 1.47
Past year merged pull request: 9
Past year bot issues: 0
Past year bot pull requests: 2
Top Issue Authors
- mdmurbach (14)
- BGerwe (14)
- lktsui (7)
- hkennyv (5)
- edmundsj (5)
- kevinsmia1939 (4)
- ravuru66 (4)
- yuchengluo (3)
- Yugal0 (3)
- svmchop (3)
- FTHuld (3)
- momoson (2)
- oslopanda (2)
- Muneebing (2)
- fatmaoza (2)
Top Pull Request Authors
- mdmurbach (41)
- allcontributors[bot] (32)
- BGerwe (28)
- lktsui (11)
- petermattia (11)
- hkennyv (5)
- etrevis (3)
- adrianusler (3)
- MattiasMTS (3)
- kevinsmia1939 (2)
- SaftMacki (2)
- andersonjacob (2)
- oslopanda (1)
- ravuru66 (1)
- pililac (1)
Top Issue Labels
- bug (50)
- enhancement (40)
- ECS Hack Week (5)
- good first issue (5)
- help wanted (4)
- documentation (3)
- question (2)
Top Pull Request Labels
- Work in Progress (2)
Package metadata
- Total packages: 1
-
Total downloads:
- pypi: 7,174 last-month
- Total dependent packages: 6
- Total dependent repositories: 5
- Total versions: 21
- Total maintainers: 1
pypi.org: impedance
A package for analyzing electrochemical impedance data
- Homepage: https://impedancepy.readthedocs.io/en/latest/
- Documentation: https://impedance.readthedocs.io/
- Licenses: MIT License
- Latest release: 1.7.1 (published almost 2 years ago)
- Last Synced: 2025-04-26T13:37:18.465Z (1 day ago)
- Versions: 21
- Dependent Packages: 6
- Dependent Repositories: 5
- Downloads: 7,174 Last month
-
Rankings:
- Dependent packages count: 1.588%
- Average: 4.418%
- Downloads: 5.052%
- Dependent repos count: 6.614%
- Maintainers (1)
Dependencies
- altair >=3.0
- coveralls ==3.2.0
- matplotlib >=3.0
- nbsphinx *
- numpy >=1.14
- numpydoc *
- pytest >=4.6
- pytest-cov *
- scipy >=1.0
- altair >=3.0
- matplotlib >=3.0
- numpy >=1.14
- scipy >=1.0
- actions/checkout v2.3.4 composite
- actions/setup-python v2.2.2 composite
- nbsphinx *
- numpydoc *
- sphinx-rtd-theme *
Score: 17.807867428675465