From 4309285e084e29fa44b7b08cf2374a81d526fdfe Mon Sep 17 00:00:00 2001
From: Carl Philipp Klemm <philipp@uvos.xyz>
Date: Fri, 27 May 2022 12:51:47 +0200
Subject: [PATCH] improve readme
---
CMakeLists.txt | 2 --
README.md | 13 ++++++++++---
2 files changed, 10 insertions(+), 5 deletions(-)
diff --git a/CMakeLists.txt b/CMakeLists.txt
index a390c51..a80b3ad 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -73,5 +73,3 @@ target_link_libraries(${PROJECT_NAME}_export ${LIBS_TEST})
target_include_directories(${PROJECT_NAME}_export PUBLIC eisgenerator)
set_target_properties(${PROJECT_NAME}_export PROPERTIES COMPILE_FLAGS "-std=c++20 -Wall -O2 -march=native -g" LINK_FLAGS "-flto")
install(TARGETS ${PROJECT_NAME}_export DESTINATION bin)
-
-
diff --git a/README.md b/README.md
index 0b6aea4..d5ed730 100644
--- a/README.md
+++ b/README.md
@@ -39,10 +39,17 @@ flags:
* Supported Elements
* c: cap
+ * one parameter: capacitance {C}
* r: resistor
+ * one parameter: resistance {R}
* l: inductor
- * w: warburg element
+ * one parameter: inductance {L}
+ * w: warburg element (infinite), one parameters {A}
+ * one parameter: Warburg coefficant {A}
* p: constant phase element
+ * two parameters: {Q, alpha}
+ * t: finite approximation of a transmition line
+ * three parameters: capacitance, resistance, approximation order {C, R, n}
--omega: range of freqency values (in rad/s) to sweep
@@ -52,13 +59,13 @@ flags:
further flags can be found with: eisgenerator_export --help
-### Spectra
+### Plot 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
+Generates Nyquist plot of model specified, allows the usage of the same flags as eisgenerator_export
## Python bindings
--
GitLab