eisgenerator

eisgenerator is a shared library (libeisgenerator.so) and CLI application that allows one to generate EIS spectra with high performance. The target application is generating test and example datasets for machine learning applications.

eisgenerator's development and target platform is UNIX, but it should compile on nigh on any platform

Compile/Install

Requirements

• git
• c++20 capable compiler (GCC, CLANG)
• cmake 3.20 or later
• optional:
  • gnuplot in $PATH

Procedure (UNIX)

In a console do:

• git clone https://git-ce.rwth-aachen.de/carl_philipp.klemm/eisgenerator.git
• cd eisgenerator
• mkdir build
• cd build
• cmake ..
• make
• sudo make install

Cross-compile for windows on UNIX

• Have the mingw cross-compile toolchain installed
• git clone https://git-ce.rwth-aachen.de/carl_philipp.klemm/eisgenerator.git
• cd eisgenerator
• mkdir build
• cd build
• cmake -DCMAKE_TOOLCHAIN_FILE=./crossW64.cmake ..
• make

Basic usage of CLI application

Generate spectra

eisgenerator_export --model="r{1e3}-r{100}c{1e-6}" --omega=1-1e6 --omegasteps=100

flags:

--model: model string, format is similar to RHD RelaxIS except that the implicit operator is parallel instead of serial, IE. "rc" is a resistor and condenser in parallel while "r-c" is the same in series and that parameters can be passed by adding {number} after the parameter, if an element requires more than one parameter they are specified by adding several comma separated values in between the brackets like so: {420, 56}

• Supported Elements
  • c: capacitor
    • one parameter: capacitance {C}
  • r: resistor
    • one parameter: resistance {R}
  • l: inductor
    • one parameter: inductance {L}
  • w: warburg element (infinite)
    • one parameter: Warburg coefficient {A}
  • p: constant phase element
    • two parameters: {Q, alpha}
  • t: closed transmititon line
    • four parameters: {R, Q, a, l}
  • o: open (reflecting) transmititon line
    • four parameters: {R, Q, a, l}

--omega: range of frequency values (in rad/s) to sweep

--omegasteps: amount of steps to take in the range specified by --omega

further flags can be found with: eisgenerator_export --help

Plot Spectra

requires gnuplot in $PATH

eisgenerator_plot --model="r{1e3}-r{100}c{1e-6}" --omega=1-1e6 --log --omegasteps=100

Generates Nyquist plot of model specified, allows the usage of the same flags as eisgenerator_export

Linking

it is best to link to this library with the help of pkg-config as this provides platform a agnostic to query for paths and flags. Almost certainly, pkg-config is already integrated into your buildsystem.

Python bindings

python bindings can be build separately from: eisgeneratorpy