DearEIS - A GUI program for analyzing impedance spectra
DearEIS - A GUI program for analyzing impedance spectra - Published in JOSS (2022)
Science Score: 98.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 4 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
○Committers with academic emails
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Repository
A GUI program for analyzing, simulating, and visualizing impedance spectra.
Basic Info
- Host: GitHub
- Owner: vyrjana
- License: gpl-3.0
- Language: Python
- Default Branch: main
- Homepage: https://vyrjana.github.io/DearEIS/
- Size: 25.5 MB
Statistics
- Stars: 85
- Watchers: 4
- Forks: 11
- Open Issues: 7
- Releases: 11
Topics
Metadata Files
README.md
DearEIS
A GUI program for analyzing, simulating, and visualizing impedance spectra.
Table of contents
About
DearEIS is a Python package that includes a program with a graphical user interface (GUI) for working with impedance spectra. An application programming interface (API) is also included that is primarily for batch processing. The target audience is researchers who use electrochemical impedance spectroscopy (EIS) though the program may also be useful in educational settings.
The GUI program implements features such as:
- projects that can contain multiple experimental data sets and analysis results
- reading certain data formats and parsing the experimental data contained within
- validation of impedance spectra using linear Kramers-Kronig tests or the Z-HIT algorithm
- estimation of the distribution of relaxation times (DRT)
- construction of circuits, e.g., by parsing circuit description codes (CDC) or by using the included graphical editor
- support for user-defined circuit elements
- complex non-linear least squares fitting of equivalent circuits
- simulation of the impedance spectra of circuits
- visualization of impedance spectra and/or various analysis results
See the official documentation for instructions on how to install DearEIS, screenshots and guides, and the API reference.
Those who would prefer to only use an API (or a command-line interface (CLI)) for everything may wish to use pyimpspec instead.
Changelog
See CHANGELOG.md for details.
Contributing
If you wish to contribute to the further development of DearEIS, then there are several options available to you depending on your ability and the amount of time that you can spare.
If you find bugs, wish some feature was added, or find the documentation to be lacking, then please open an issue on GitHub.
If you wish to contribute code, then start by cloning the repository:
git clone https://github.com/vyrjana/DearEIS.git
The development dependencies can be installed from within the repository directory:
pip install -r ./dev-requirements.txt
Create a new branch based on either the main branch or the most recent development branch (e.g., dev-*), and submit your changes as a pull request.
Note that some of the core functionality of DearEIS is based on pyimpspec and thus certain changes (e.g., parsers for data formats) should be contributed to that project instead.
Code contributions should, if it is applicable, also include unit tests, which should be implemented in files placed in the tests folder found in the root of the repository along with any assets required by the tests.
It should be possible to run the tests by executing the run_tests.sh script, which uses the test discovery built into the unittest module that is included with Python.
See CONTRIBUTORS for a list of people who have contributed to the DearEIS project.
License
Copyright 2025 DearEIS developers
DearEIS is licensed under the GPLv3 or later.
The licenses of DearEIS' dependencies and/or sources of portions of code are included in the LICENSES folder.
Owner
- Name: Ville Yrjänä
- Login: vyrjana
- Kind: user
- Location: Turku, Finland
- Repositories: 3
- Profile: https://github.com/vyrjana
JOSS Publication
DearEIS - A GUI program for analyzing impedance spectra
Authors
Åbo Akademi University, Faculty of Science and Engineering, Johan Gadolin Process Chemistry Centre, Laboratory of Molecular Science and Engineering, Turku (Åbo), Finland
Editor
Jeff Gostick
Tags
electrochemistry impedance spectroscopyCitation (CITATION.cff)
cff-version: 1.2.0
message: If you use this software, please cite it using these metadata.
title: DearEIS
type: software
identifiers:
- description: Archived snapshots of versions
type: doi
value: "10.5281/zenodo.7371986"
license: GPL-3.0-or-later
repository-code: "https://github.com/vyrjana/DearEIS"
authors:
- family-names: Yrjänä
given-names: Ville
orcid: "https://orcid.org/0000-0001-5779-5201"
preferred-citation:
type: article
doi: "10.21105/joss.04808"
url: "https://joss.theoj.org/papers/10.21105/joss.04808"
year: 2022
volume: 7
number: 80
pages: 4808
title: "DearEIS - A GUI program for analyzing impedance spectra"
journal: "Journal of Open Source Software"
authors:
- family-names: Yrjänä
given-names: Ville
orcid: "https://orcid.org/0000-0001-5779-5201"
GitHub Events
Total
- Create event: 3
- Issues event: 5
- Release event: 2
- Watch event: 27
- Delete event: 1
- Issue comment event: 16
- Push event: 6
- Fork event: 2
Last Year
- Create event: 3
- Issues event: 5
- Release event: 2
- Watch event: 27
- Delete event: 1
- Issue comment event: 16
- Push event: 6
- Fork event: 2
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 24
- Total pull requests: 1
- Average time to close issues: about 2 months
- Average time to close pull requests: about 2 hours
- Total issue authors: 18
- Total pull request authors: 1
- Average comments per issue: 3.58
- Average comments per pull request: 0.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 7
- Pull requests: 0
- Average time to close issues: about 22 hours
- Average time to close pull requests: N/A
- Issue authors: 7
- Pull request authors: 0
- Average comments per issue: 1.71
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- Aslan-Kosakian (6)
- kmylrea (1)
- chemsauce21 (1)
- GregAlex7 (1)
- grgrgruen (1)
- Up2nothing (1)
- diluculo (1)
- QC1130 (1)
- zionLi3 (1)
- fbordwell (1)
- bandit-masked (1)
- andremugen24 (1)
- WenyangX (1)
- vyrjana (1)
- Clement-Nicollet (1)
Pull Request Authors
- vyrjana (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 204 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 35
- Total maintainers: 1
pypi.org: deareis
A GUI program for analyzing, simulating, and visualizing impedance spectra.
- Homepage: https://vyrjana.github.io/DearEIS
- Documentation: https://vyrjana.github.io/DearEIS/api/
- License: GPLv3
-
Latest release: 5.1.1
published 10 months ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- build * development
- flake8 * development
- setuptools * development
- dearpygui ==1.8.0
- pyimpspec *
- requests *
- xdg *