Skip to main content

MADAP

https://github.com/fuzhanrahmanian/MADAP/blob/master/logo.png?raw=true

Modular and Autonomous Data Analysis Platform (MADAP) is a well-documented python package which can be used for electrochmeical data analysis.

This package consists of 3 main classes for analysis:

  • Voltammetry

  • Impedance spectroscopy

  • Arrhenius

This package allows user to upload any common file format of data and the select the data of choice. The user can use to scientifically plot and get correspondence analysis from each procedure (i.e. by calling “eis_analysis” , Nyquist, bode as well as the correspondence equivalent circuit and its parameters will be drawn). This package can be installed via pip/conda and can be utilized with a GUI, command line or just directly importing the module in a python script.

Documentation

A documentation for the implementation and use of MADAP can be found here

Installation

MADAP can be installed via pip:

pip install MADAP

Usage

A brief tutorial video of the basic of MADAP usage can found here.

MADAP can be used in a python script as follows:

from madap.echem.arrhenius import arrhenius
from madap.echem.e_impedance import e_impedance
from madap.data_acquisition import data_acquisition as da


# Load the data
data = da.acquire_data('data.csv')
# Define the desired plots for Arrhenius analysis
plots_arr = ["arrhenius", "arrhenius_fit"]
# Define the desired plots for impedance analysis
plots_eis = ["nyquist", "nyquist_fit", "bode", "residual"]
# Define a save location#
save_dir = "/results"

### Arrhenius
# Instantiate the Arrhenius class for analysis (column names do not have to match exactly, this is just an example)
Arr = arrhenius.Arrhenius(da.format_data(data["temperature"], da.format_data(data["conductivity"])))
# Perform analysis and plotting
Arr.perform_all_actions(save_dir, plots = plots_arr)

### Impedance
# Initialize the Impedance class for analysis (column names do not have to match exactly, this is just an example)
Im = e_impedance.EImpedance(da.format_data(data["freq"]), da.format_data(data["real"]), da.format_data(data["img"]))
# Initialis the EIS procedure. The initial value is the initial guess for the equivalent circuit (can also be left empty)
Eis  = e_impedance.EIS(Im, suggested_circuit = "R0-p(R1,CPE1)",initial_value =[860, 3e+5, 1e-09, 0.90])
# Analyze the data
Eis.perform_all_actions(save_dir, plots = plots_eis)

# More usages and options can be found in the documentation.

MADAP can also be used via command line:

python -m madap_cli --file <path_to_file> --procedure <procedure> --results <path_to_results> --header_list <header_list> --plot <list_of_plots>

MADAP can also be used via a GUI:

python -m madap_gui
https://github.com/fuzhanrahmanian/MADAP/raw/master/GUI.png

License

MADAP is licensed under the MIT license. See the LICENSE file for more details.

Citation

If you use MADAP in your research, please cite this GitHub repository https://github.com/fuzhanrahmanian/MADAP.

https://zenodo.org/badge/494354435.svg

Please also cite the following work: [Rahmanian2023] Rahmanian, F., Vogler, M., Wölke, C. et al. “Conductivity experiments for electrolyte formulations and their automated analysis.” Sci Data 10, 43 (2023).

References

This package is based relies on the following packages and papers: - Impedance GitHub repository by Matthew D. Murbach and Brian Gerwe and Neal Dawson-Elli and Lok-kun Tsui: link - A Method for Improving the Robustness of linear Kramers-Kronig Validity Tests DOI: https://doi.org/10.1016/j.electacta.2014.01.034

Acknowledgement

This project has received funding from the European Union’s [Horizon 2020 research and innovation programme](https://ec.europa.eu/programmes/horizon2020/en) under grant agreement [No 957189](https://cordis.europa.eu/project/id/957189). The project is part of BATTERY 2030+, the large-scale European research initiative for inventing the sustainable batteries of the future.

History

1.2.8 (2025-04-28)

  • Fixed bug from merge conflict

1.2.7 (2025-04-24)

  • Added support for no time data in CV

  • Fixed bug in CV for no time data and CLI

1.2.6 (2023-12-16)

  • Fixed bug in CP for differential capacity plot

  • Handled None and Infinite values in CP plots

  • Fixed index in CV

1.2.5 (2023-12-15)

  • Fixed bug in CA for zero reaction rate constant

  • Fixed bug in index handling for CA

  • Fixed bug in plot ticks

1.2.3 (2023-12-11)

  • Include python 3.8

1.2.1 (2023-12-11)

  • Added Ciclic Voltammetry to the functions

  • CA, CP and CV can be used with multiple plots to chose from

  • New and Imrpoved GUI

  • Fixed saving bug

1.1.0 (2023-08-07)

  • Fixes issue with mismatch array length when positive imaginary data is given

0.11.0 (2022-10-16)

  • Fixed bugs concering the package installation.

  • Improved the documentation.

  • Imrpoved the file structure.

  • madap_gui and madap_cli are now in the same package and can be used as standalone scripts/commands.

0.10.0 (2022-10-03)

  • Updated support of the python versions

0.9.0 (2022-10-02)

  • Update documentation

0.8.0 (2022-10-02)

  • First release on PyPI.

Metadata

Release files for MADAP 1.2.8

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

Source distribution (sdist)

Source distribution for MADAP 1.2.8
File Size Uploaded
madap-1.2.8.tar.gz 64.4 kB Details

Built distribution (wheel)

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

Total release size: 171.9 kB

Release files / madap-1.2.8.tar.gz

Download URL madap-1.2.8.tar.gz
Size 64.4 kB
Tags Source
SHA-256 checksum
How to use checksums
85d60799e65a6e8029e03ab61a62590f60c3368e5805204f00a0dd68c7906b08
BLAKE2b-256 checksum
How to use checksums
b68b8e4b6524da201c4e333fb05944fe0f1aaf035604283fda591daf45187181
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.21

Release files / MADAP-1.2.8-py3-none-any.whl

Download URL MADAP-1.2.8-py3-none-any.whl
Size 107.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bbcdbc537edca45511c9159b01eaa2f943d88b1c6a7f7849a0262849901ba030
BLAKE2b-256 checksum
How to use checksums
fdcdd323e70841fd63f8133da12f517d40d910e73a3281972ab749a87dfe39f2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.21

Release history Release notifications | RSS feed

This release

1.2.8 This release

2 release files

1.2.7

2 release files

1.2.6

2 release files

1.2.5

2 release files

1.2.4

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.0

2 release files

0.11.0

2 release files

0.9.0

2 release files

0.8.0

1 release file

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