From 754608bd4e57ee1ceb3a54836a71c82cad22e55e Mon Sep 17 00:00:00 2001
From: Carl Philipp Klemm <philipp@uvos.xyz>
Date: Wed, 11 May 2022 17:56:23 +0200
Subject: [PATCH] improve readme
---
README.md | 21 +++++++++++++++++----
1 file changed, 17 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index d591e3d..1056c17 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# eisgenerator
-eisgenerator is a shared libary and CLI application that allows one to generate [EIS](https://de.wikipedia.org/wiki/Impedanzspektroskopie) spectra with high performance.
+eisgenerator is a shared libary (libeisgenerator.so) and CLI application that allows one to generate [EIS](https://de.wikipedia.org/wiki/Impedanzspektroskopie) spectra with high performance.
The target application is genrating test and example datasets for machine lerning applications.
eisgenerator's development and target platform is UNIX, but it should compile on nigh any platform
@@ -29,13 +29,19 @@ In a console do:
## Basic usage of CLI application
-## Generate spectra
+### Generate spectra
eisgenerator_export --model="r{1e3}-r{100}c{1e-6}" --omega=1-1e6 --log --omegasteps=100
flags:
---model: model string, format is simmular 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.
+--model: model string, format is simmular 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 seperated values in between the brackets like so: {420, 56}
+
+* Supported Elements
+ * c: cap
+ * r: resistor
+ * w: warburg element
+ * p: constant phase element
--omega: range of freqency values (in rad/s) to sweep
@@ -43,8 +49,15 @@ flags:
--omegasteps: amount of steps to take in the range specified by --omega
-further flags can be found with eisgenerator_export --help
+further flags can be found with: eisgenerator_export --help
+
+### Spectra
+
+requires [gnuplot](http://www.gnuplot.info/) in $PATH
+
+eisgenerator_plot --model="r{1e3}-r{100}c{1e-6}" --omega=1-1e6 --log --omegasteps=100
+Generates Nyquist plot of model specified, allos usage of the same flags as eisgenerator_export
## Python bindings
--
GitLab