Skip to main content

DOI pre-commit.ci status

ImpedanceFitter

Impedance spectroscopy (IS) is a great tool to analyse the behaviour of an electrical circuit, to characterise the response of a sample (e.g. biological tissue), to determine the dielectric properties of a sample, and much more1.

In IS, often (complex) non-linear least squares is used for parameter estimation of equivalent circuit models. ImpedanceFitter is a software that facilitates parameter estimation for arbitrary equivalent circuit models. The equivalent circuit may comprise different standard elements or other models that have been formulated in the context of impedance spectroscopy. The unknown parameters are found by fitting the model to experimental impedance data. The underlying fitting software is LMFIT2, which offers an interface to different optimization and curve-fitting methods going beyond standard least-squares.

ImpedanceFitter allows one to build a custom equivalent circuit, fit an arbitrary amount of data sets and perform statistical analysis of the results using OpenTurns3.

Documentation

The documentation is available at Read the Docs.

If you want to compile it locally: The documentation is in the doc directory and requires Sphinx to be compiled. A requirements file can be found in the doc directory.

Installation

ImpedanceFitter works with Python >= 3.6.

ImpedanceFitter can be installed using pip

pip install impedancefitter

The statistical analysis of fit results (PostProcess) relies on OpenTURNS, which is an optional dependency. To install it as well, run

pip install impedancefitter[stats]

If you want to install the code from source, clone into a local directory.

cd into this directory and run

pip install -e . --user

in this directory. It will install all requirements automatically. Moreover, you can edit the source code and run the edited version without reinstalling.

Testing

The tests use pytest. Simply run pytest inside the repository main directory.

Use ImpedanceFitter

Check out the examples directory and the documentation to see how ImpedanceFitter is supposed to work.

Contribute

If you find bugs or missing functionality, feel free to raise an issue here on github or create a pull request!

References

1: Barsoukov, E., & Macdonald, J. R. (Eds.). (2018). Impedance Spectroscopy: Theory, Experiment, and Applications. (3rd ed.). Hoboken, NJ: John Wiley & Sons, Inc. https://doi.org/10.1002/9781119381860

2: Newville, M., & et al. (2020, May 7). lmfit/lmfit-py 1.0.1 (Version 1.0.1). Zenodo. http://doi.org/10.5281/zenodo.3814709

3: Baudin, M., Dutfoy, A., Looss, B., & Popelin, A. L. (2017). OpenTURNS: An industrial software for uncertainty quantification in simulation. In Handbook of Uncertainty Quantification (pp. 2001–2038). https://doi.org/10.1007/978-3-319-12385-1_64

Metadata

Release files for impedancefitter 2.0.13

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for impedancefitter 2.0.13
File Size Uploaded Provenance Actions
impedancefitter-2.0.13.tar.gz 4.3 MB With provenance Details for impedancefitter-2.0.13.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for impedancefitter 2.0.13
File Interpreter ABI Platform Actions
impedancefitter-2.0.13-py3-none-any.whl Python 3 none any Details for impedancefitter-2.0.13-py3-none-any.whl

Total release size: 4.4 MB

Release files / impedancefitter-2.0.13.tar.gz

Download URL impedancefitter-2.0.13.tar.gz
Size 4.3 MB
Tags Source
SHA-256 checksum
How to use checksums
87e9988d067c5592867920a3d6337e21af489007e808076399b47b1ac712473e
BLAKE2b-256 checksum
How to use checksums
d1421bc07764d6f0fbb9057b951de0e8263e1499dcb8612df6fdadf0a2328bbd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.

Transparency log

Release files / impedancefitter-2.0.13-py3-none-any.whl

Download URL impedancefitter-2.0.13-py3-none-any.whl
Size 117.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3ab2693d9fd1a9fa5c0862d753ebdf4530e3c9fc63d8f2c0eabd8c38eeda164e
BLAKE2b-256 checksum
How to use checksums
171a568cbd5bd0c65be0978a8380550e186703866ce9545b0d88a37bee576373
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.

Transparency log

Security for impedancefitter 2.0.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for impedancefitter-2.0.13.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page