nleis.py documentation

Version: 0.3

Useful links: Home | Installation | Source repository | Issue tracker | Examples

nleis.py extends impedance.py with tools for nonlinear equivalent circuit modeling, EIS analysis, and second-harmonic nonlinear electrochemical impedance spectroscopy (2nd-NLEIS). The documentation is organized around the same workflow as the package: install the library, prepare data, fit EIS and 2nd-NLEIS models, validate results, and inspect the public API reference.

Getting started

Install nleis.py, load example data, process harmonics, build a paired model, fit data, and plot results.

To the getting started guide

User guide

Read the conceptual documentation for model pairs, preprocessing, validation, fitting, visualization, and batch workflows.

To the user guide

Examples

Run notebooks that demonstrate NLEIS fitting, graph implementation, validation, multistart fits, and batch analysis.

To the examples

API reference

The reference guide contains a detailed description of the function, modules, and objects included in nleis.py. The reference describes how the methods work and which parameters can be used.

To the API reference