diff --git a/CMakeLists.txt b/CMakeLists.txt index a390c51a19b34cc6ee9706458789efc8a58b3f42..a80b3adccff89c07f01222423efc79fc349e6313 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 0b6aea401c99eadd4f9f9a66f2acf3b3c556b67b..d5ed73009c4682e1b73b130b9ca90e8f5ffa4eec 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