Welcome to pyimpspec’s documentation!

Pyimpspec is a Python package for processing, analyzing, and visualizing impedance spectra.

Note

PDF copies of the documentation are available in the releases section.

The primary interface for using pyimpspec is the application programming interface (API).

>>> import pyimpspec

A command-line interface (CLI) is also included to provide a way to, e.g., quickly plot some experimental data via a terminal.

# The CLI should be accessible in the terminal in the following ways
pyimpspec
python -m pyimpspec

Note

If you would prefer to use a graphical user interface (GUI), then check out DearEIS.

The source code for pyimpspec can be found here. The changelog can be found here. If you encounter bugs or wish to request a feature, then please open an issue on GitHub. If you wish to contribute to the project, then please read the readme before submitting a pull request via GitHub.

Pyimpspec is licensed under GPLv3 or later.

Contents:

• Getting started
  • Installing
  • Data parsing
  • Kramers-Kronig testing
  • Z-HIT analysis
  • Distribution of relaxation times
  • Equivalent circuits
  • Circuit fitting
  • Command-line interface (CLI)
• API Documentation
  • get_default_num_procs()
  • set_default_num_procs()
  • Data parsing
  • Mock data
  • Kramers-Kronig testing
  • Z-HIT analysis
  • Distribution of relaxation times
  • Equivalent circuits
  • Circuit fitting
  • Plotting - matplotlib
  • Typing
  • Exceptions
  • Progress