https://github.com/richinex/pymultipleis

A library for fitting a sequence of electrochemical impedance spectra (JAX version).
https://github.com/richinex/pymultipleis

impedance-spectroscopy jax minimization-algorithm multiple

Last synced: 5 months ago
JSON representation

A library for fitting a sequence of electrochemical impedance spectra (JAX version).

• Host: GitHub
• URL: https://github.com/richinex/pymultipleis
• Owner: richinex
• License: mit
• Created: 2022-09-26T19:44:07.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-06T11:34:49.000Z (over 3 years ago)
• Last Synced: 2026-01-01T19:39:28.404Z (5 months ago)
• Topics: impedance-spectroscopy, jax, minimization-algorithm, multiple
• Language: Python
• Homepage: https://pymultipleis.readthedocs.io/en/latest/index.html#
• Size: 39.3 MB
• Stars: 6
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          

# pymultipleis

[**Installation**](#installation)

| [**Examples**](https://github.com/richinex/pymultipleis/tree/main/docs/source/examples)

| [**Documentation**](https://pymultipleis.readthedocs.io/en/latest/index.html)

| [**Citing this work**](#citation)

A library for fitting a sequence of electrochemical impedance spectra.

- Implements algorithms for simultaneous and sequential fitting.

- Written in python and based on the [JAX library](https://github.com/google/jax).

- Leverages JAX's in-built automatic differentiation ([autodiff](https://jax.readthedocs.io/en/latest/notebooks/autodiff_cookbook.html)) of Python functions.

- Takes advantage of JAX's just-in-time compilation (JIT) of Python code to [XLA](https://www.tensorflow.org/xla) which runs on GPU or TPU hardware.

## Installation

pymultipleis requires the following:

-   Python (>=3.9)

-   [JAX](https://jax.readthedocs.io/en/latest/) (>=0.3.17)

Installing JAX on Linux is natively supported by the JAX team and instructions to do so can be found [here](https://github.com/google/jax#installation).

For Windows systems, the officially supported method is building directly from the source code (see [Building JAX from source](https://jax.readthedocs.io/en/latest/developer.html#building-from-source)).

However, it might be easier to use pre-built JAX wheels which can be found in this [Github repo](https://github.com/cloudhan/jax-windows-builder). Further details

on Windows installation is also provided in this [repo](https://github.com/Dipolar-Quantum-Gases/jaxfit/blob/main/README.md).

After installing JAX, you can now install pymultipleis via the following pip command

```bash

pip install pymultipleis

```

[Getting started with pymultipleis](https://pymultipleis.readthedocs.io/en/latest/quick-start-guide.html#) contains a quick start guide to

fitting your data with ``pymultipleis``.

## Examples

Jupyter notebooks which cover several aspects of ``pymultipleis`` can be found in [Examples](https://github.com/richinex/pymultipleis/tree/main/docs/source/examples).

## Documentation

Details about the ``pymultipleis`` API, can be found in the [reference documentation](https://pymultipleis.readthedocs.io/en/latest/index.html).

## Citing this work

If you use pymultipleis for academic research, you may cite the library as follows:

```

@misc{Chukwu2022,

  author = {Chukwu, Richard},

  title = {pymultipleis: a library for fitting a sequence of electrochemical impedance spectra},

  publisher = {GitHub},

  year = {2022},

  url = {https://github.com/richinex/pymultipleis},

}

```