impedance.py
impedance.py: A Python package for electrochemical impedance analysis - Published in JOSS (2020)
Science Score: 100.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 9 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: arxiv.org, joss.theoj.org, zenodo.org -
✓Committers with academic emails
8 of 26 committers (30.8%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Scientific Fields
Repository
A Python package for working with electrochemical impedance data
Basic Info
Statistics
- Stars: 255
- Watchers: 21
- Forks: 114
- Open Issues: 56
- Releases: 21
Topics
Metadata Files
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.
bash
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
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 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!
Owner
- Name: ECS Hack Week
- Login: ECSHackWeek
- Kind: organization
- Repositories: 7
- Profile: https://github.com/ECSHackWeek
JOSS Publication
impedance.py: A Python package for electrochemical impedance analysis
Authors
Hive Battery Labs, Seattle, WA, USA
University of Washington, Department of Chemical Engineering, Seattle, WA, USA
PayScale, Seattle, WA, USA
University of New Mexico, Center for MicroEngineered Materials, Albuquerque, NM, USA
Editor
Monica Bobra
Tags
electrochemistry impedance lithium-ion batteries fuel cells corrosionCitation (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
GitHub Events
Total
- Issues event: 5
- Watch event: 36
- Issue comment event: 2
- Pull request event: 1
- Fork event: 10
Last Year
- Issues event: 5
- Watch event: 36
- Issue comment event: 2
- Pull request event: 1
- Fork event: 10
Committers
Last synced: 5 months ago
Top Committers
| 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 (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 151
- Total pull requests: 160
- Average time to close issues: 3 months
- Average time to close pull requests: 26 days
- Total issue authors: 85
- Total pull request authors: 32
- Average comments per issue: 2.51
- Average comments per pull request: 1.94
- Merged pull requests: 137
- Bot issues: 0
- Bot pull requests: 31
Past Year
- Issues: 5
- Pull requests: 5
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 5
- Pull request authors: 4
- Average comments per issue: 0.4
- Average comments per pull request: 0.6
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- mdmurbach (14)
- BGerwe (14)
- lktsui (7)
- hkennyv (5)
- edmundsj (5)
- ravuru66 (4)
- yuchengluo (3)
- kevinsmia1939 (3)
- Yugal0 (3)
- FTHuld (3)
- svmchop (3)
- oslopanda (2)
- Muneebing (2)
- fatmaoza (2)
- aokomorowski (2)
Pull Request Authors
- mdmurbach (41)
- allcontributors[bot] (33)
- BGerwe (29)
- lktsui (11)
- petermattia (11)
- adrianusler (5)
- hkennyv (5)
- MattiasMTS (3)
- Gnpd (2)
- etrevis (2)
- andersonjacob (2)
- ma-sadeghi (2)
- kevinsmia1939 (2)
- MarcinK00 (2)
- SaftMacki (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 3
-
Total downloads:
- pypi 3,673 last-month
-
Total dependent packages: 6
(may contain duplicates) -
Total dependent repositories: 5
(may contain duplicates) - Total versions: 59
- 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/
- License: MIT License
-
Latest release: 1.7.1
published over 2 years ago
Rankings
Maintainers (1)
proxy.golang.org: github.com/ecshackweek/impedance.py
- Documentation: https://pkg.go.dev/github.com/ecshackweek/impedance.py#section-documentation
- License: mit
-
Latest release: v1.7.1
published over 2 years ago
Rankings
proxy.golang.org: github.com/ECSHackWeek/impedance.py
- Documentation: https://pkg.go.dev/github.com/ECSHackWeek/impedance.py#section-documentation
- License: mit
-
Latest release: v1.7.1
published over 2 years ago
Rankings
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 *