some readme

This commit is contained in:
Mario Fink 2019-07-05 12:32:17 +02:00
parent 27b0a38b9c
commit da8903d0d2

View File

@ -34,14 +34,26 @@ wrapper.
- eFloat32Usi: 32 byte - eFloat32Usi: 32 byte
- eFloat64Usi: 64 byte - eFloat64Usi: 64 byte
- main.cpp contains an example of how the C++ library might be used to provide - main.cpp contains an example of how the C++ library might be used to provide
the channels and groups of the dataset. the channels and groups of the dataset. It is simply build by
```Shell
make
```
- extract_all.cpp takes the .tdm, the .tdx file and some output directory as arguments - extract_all.cpp takes the .tdm, the .tdx file and some output directory as arguments
to provide all given information in .csv format without any logging. to provide all given information in .csv format without any logging.
```Shell
make extall
```
### Python module ### Python module
- The library may also be used as a Python module and supports the use of - The library may also be used as a Python module and supports the use of
group channels in NumPy arrays as shown in example.py . group channels in NumPy arrays as shown in example.py .
- To extract all available information and data in the TDM files without any - To extract all available information and data in the TDM files without any
further interaction, the use of extract_all.py is recommended. To exhibit the further interaction, the use of extract_all.py is recommended. To exhibit the
required arguments call $ python extract_all.py --help . required arguments:
```Shell
python extract_all.py --help
```