Skip to content

Commit 0f3f3c7

Browse files
authored
README and Documentation updates (#26)
1 parent 34261e5 commit 0f3f3c7

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
# nleis.py
22

3-
`nleis.py` is designed as a toolbox that enables nonlinear impedance analysis for impedance.py. Key features include nonlinear ECMs and simultaneous analysis of EIS and 2nd-NLEIS. This repo will contains most recent version of `nleis.py`. As of today `nleis.py` supports the latest version of `impedance.py 1.7.1`.
3+
Second-harmonic nonlinear electrochemical impedance spectroscopy (2nd-NLEIS), a special form of nonlinear electrochemical impedance spectroscopy (NLEIS), is emerging as a powerful complementary technique to traditional electrochemical impedance spectroscopy (EIS). It retains the experimental simplicity of EIS while providing additional physical insights. However, its adoption and application have been limited by the lack of open-source, user-friendly software.
4+
5+
`nleis.py` aims to address this gap by providing a Python toolbox that is designed to work with and extend the capabilities of `impedance.py`. Key features include:
6+
7+
- Nonlinear equivalent circuit modeling (nECM)
8+
- Simultaneous analysis of EIS and 2nd-NLEIS data
9+
10+
This repository contains the most recent version of nleis.py. As of today, nleis.py supports the latest version of `impedance.py (v1.7.1)`.
411

512
### Installation
613

@@ -31,6 +38,14 @@ In the near future, you will be able to access all the funcationality for `nleis
3138

3239
The detailed documentation can be found at [nleispy.readthedocs.io](https://nleispy.readthedocs.io/en/latest).
3340

41+
### Contributing to nleis.py
42+
43+
The nleis.py project welcomes all kinds of contributions, including bug fixes, feature requests, code reviews, new features, examples, documentation improvements, and community engagement. For any changes involving the repository, please refer to the detailed guidance in the [`CONTRIBUTING.md`](https://github.com/yuefan98/nleis.py/blob/main/CONTRIBUTING.md). If you encounter any issues or have suggestions, feel free to submit an [issue](https://github.com/yuefan98/nleis.py/issues) to let us know.
44+
45+
We are also excited to see contributions that expand the capabilities of `nleis.py`. Potential future features include:
46+
47+
- EIS and 2nd-NLEIS data processing from the time domain
48+
- Data validation for 2nd-NLEIS
3449

3550
### Credits
3651
----------------------------------------------------------------

nleis/nleis_elements_pair.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -578,7 +578,7 @@ def TPn(p, f):
578578
def TDP(p, f):
579579
"""
580580
581-
EIS: orous electrode with high conductivity matrix
581+
EIS: Porous electrode with high conductivity matrix
582582
and planar diffusion into platelet-like particles from Ji et al. [1]
583583
584584
Notes

0 commit comments

Comments
 (0)