Skip to content
Snippets Groups Projects
Commit 019e3fe0 authored by Carl Philipp Klemm's avatar Carl Philipp Klemm
Browse files

update docs again a bit

parent 0da386c8
No related branches found
No related tags found
No related merge requests found
......@@ -76,10 +76,12 @@ eisgenerator_plot --model="r{1e3}-r{100}c{1e-6}" --omega=1-1e6 --log --omegastep
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](https://www.freedesktop.org/wiki/Software/pkg-config/) as this provides platform a agnostic to query for paths and flags. Almost certenly, pkg-config is already integrated into your buildsystem.
## Python bindings
python bindings can be build separately from: [eisgeneratorpy](https://git-ce.rwth-aachen.de/carl_philipp.klemm/eisgeneraorpy)
python bindings can be build separately from: [eisgeneratorpy](https://github.com/IMbackK/eisgeneratorpy)
### Linking
it is best to link to this library with the help of [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/) as this provides platform a agnostic to query for paths and flags. Almost certenly, pkg-config is already integrated into your buildsystem.
\mainpage @PROJECT_NAME@ manual
**@PROJECT_NAME@** is a C++ shared library (lib@PROJECT_NAME@.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. @PROJECT_NAME@'s development and target platform is GNU/Linux, but besides a c++20 compiler and libstd++ it has no dependencies and should compile on nigh any platform. @PROJECT_NAME@ also has python bindings, not described here, but note that using these erases a lot of the performance benefit of using this library. For information on how to build this library please look at the \ref README
**@PROJECT_NAME@** is a C++ shared library (lib@PROJECT_NAME@.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. @PROJECT_NAME@'s development and target platform is GNU/Linux, but besides a c++20 compiler and libstd++ it has no dependencies and should compile on nigh any platform. @PROJECT_NAME@ also has python bindings, described [here](https://github.com/IMbackK/eisgeneratorpy), but note that using these erases a lot of the performance benefit of using this library. For information on how to build this library please look at the \ref README
for an example on how to use the library see example tab above, for API documentation start here:
* eis::Model
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment