imc_conversion.hpp: more comprehensive error message, imc_datatype: imc_Ulongint,imc_Slongint typedef for x86_64 vs. arm

* usage.py: raise proper exception
* usage_adv.py: use different example file

.gitignore

@@ -20,3 +20,12 @@ cython/*.cpp
 *.parquet
 
 src/*.cpp.cpp
+
+pip/*.cpp
+pip/*.hpp
+pip/*.pyx
+pip/*.pxd
+pip/README.md
+pip/LICENSE
+pip/*egg-info
+pip/dist/

Dockerfile

@@ -4,8 +4,9 @@ FROM debian:bullseye-20210111
 USER root
 
 RUN apt-get update && apt-get install -y \
-    build-essential git \
+    build-essential git vim \
     python3 python3-pip
+RUN python3 -m pip install cython
 
 RUN g++ -v
 
@@ -15,6 +16,6 @@ COPY ./ /IMCtermite/
 RUN cd /IMCtermite && ls -lh && make install && ls -lh /usr/local/bin/imctermite
 
 # install Python module
-# RUN cd /tdm_ripper && ls -lh && make cython-requirements && make cython-install
+RUN cd /IMCtermite && ls -lh && make cython-install
 
-CMD ["sleep","inifity"]
+CMD ["sleep","infinity"]

README.md

@@ -10,16 +10,18 @@
 </p>
 
 _IMCtermite_ provides access to the proprietary data format
-_IMC Bus Format_ with file extension _.raw_ introduced and developed by
+_IMC Bus Format_ with the file extension _.raw_ introduced and developed by
 [imc Test & Measurement GmbH](https://www.imc-tm.de/). This data format is
 employed i.a. by the measurement hardware
 [imc CRONOSflex](https://www.imc-tm.de/produkte/messtechnik-hardware/imc-cronosflex/ueberblick/)
 to dump and store data and the software packages
 [imc Studio](https://www.imc-tm.de/produkte/messtechnik-software/imc-studio/ueberblick/)
-and [imc FAMOS](https://www.imc-tm.de/produkte/messtechnik-software/imc-famos/)
-for measurement data control and analysis. The extracted measurement data can
-be stored in various open source file formats like _csv_, _json_, _parquet_ or
-_hdf5_.
+& [imc FAMOS](https://www.imc-tm.de/produkte/messtechnik-software/imc-famos/)
+for measurement data control and analysis. Thanks to the integrated Python module,
+the extracted measurement data can be stored in any open-source file format
+accessible by Python like i.a. _csv_, _json_ or _parquet_.
+
+On the [Record Evolution Platform](https://www.record-evolution.de/en/home-en/), the library can be used both as a command line tool for interactive usage and as a Python module to integrate the _.raw_  format into any ETL workflow.   
 
 ## Overview
 
@@ -28,16 +30,15 @@ _hdf5_.
 * [Usage and Examples](#Usage)
 * [References](#References)
 
-## Fileformat
+## File format
 
-A data file of _IMC Bus Format_ type with extension _.raw_ is a _mixed text/binary
+A data file of the _IMC Bus Format_ type with the extension _.raw_ is a _mixed text/binary
 file_ featuring a set of markers (keys) that indicate the start of various blocks
-of data providing meta information and the actual measurement data. Every single
-marker is introduced by character `"|" = 0x 7c` followed by two uppercase letters,
-which characterize the type of marker. Each block is further divided into several
+of data that provide meta information and the actual measurement data. Every single
+marker is introduced by the character `"|" = 0x 7c` followed by two uppercase letters that characterize the type of marker. Each block is further divided into several
 parameters separated by commata `"," = 0x 2c` and terminated by a semicolon
 `";" = 0x 3b`. For instance, the header - first 600 bytes - of a raw file may
-look like this (in UTF-8 encoding)
+look like this (in UTF-8 encoding):
 
 ```
 |CF,2,1,1;|CK,1,3,1,1;
@@ -49,8 +50,8 @@ look like this (in UTF-8 encoding)
 |CS,1,      9619,         1,<2C>oD	<09>nD6<44>nD)<29>nD<6E>
 ```
 
-where line breaks where introduced for readability. Most of the markers introduce
-blocks of text, while only the last one identified by `|CS` contains binary data.
+Line breaks are introduced for readability. Most of the markers introduce
+blocks of text, while only the last block identified by `|CS` contains binary data.
 The format supports the storage of _multiple data sets (channels)_ in a single
 file. The channels may be ordered in _multiplex_ mode (ordering w.r.t. time) or
 _block_ mode (ordering w.r.t. to channels).
@@ -61,7 +62,7 @@ letters. There are _two types_ of markers distinguished by the first letter:
 1. _critical_ markers: introduced by `|C` featuring uppercase `C`
 1. _noncritical_ markers: introduced by `|N` featuring uppercase `N`  
 
-The second letter represents further details of the specific key. Note, that
+The second letter represents further details of the specific key. Note that
 while the _noncritical_ keys are optional, any _.raw_ file _cannot be_ correctly
 decoded if any of the _critical_ markers are misinterpreted, invalid or damaged.
 The second uppercase letter is followed by the first comma and the _version_
@@ -70,9 +71,9 @@ representation) specifies the length of the entire block, i.e. the number of
 bytes between the following comma and the block-terminating semicolon. The further
 structure of a block is not defined and may feature different numbers of additional
 parameters. The format allows for any number of carriage returns (`CR = 0x0d`)
-and line feeds (`LF = 0x 0a`) between keys, i.e. the block terminating semicolon
+and line feeds (`LF = 0x 0a`) between keys, i.e. the block-terminating semicolon
 and the vertical bar (pipe) of the next key. The following _critical markers_
-are defined
+are defined:
 
 
 | marker | description                                                                                         |
@@ -118,8 +119,8 @@ module.
 
 ### CLI tool
 
-To build the CLI tool locally use the default target `make`  resulting
-in the binary `imctermite`. To ensure system-wide availability the installation
+To build the CLI tool locally, use the default target `make` resulting
+in the binary `imctermite`. To ensure system-wide availability, the installation
 of the tool (in the default location `/usr/local/bin`) is done via
 
 ```
@@ -130,27 +131,40 @@ which may require root permissions.
 
 ### Python
 
-To integrate the library into a customized ETL toolchain several cython targets
-are available. For a local build that enables you to run the examples use:
+To integrate the library into a customized ETL toolchain, several cython targets
+are available. For a local build that enables you to run the examples, use:
 
 ```
 make cython-build
 ```
 
-However, in a production environment a proper installation of the module with
+However, in a production environment, a proper installation of the module with
 `make cython-install` is recommended for system-wide availability of the module.
 
+#### Installation with pip
+
+The package is also available in the [Python Package Index](https://pypi.org)
+at [IMCtermite](https://pypi.org/project/IMCtermite/).
+To install the latest version simply do
+
+```Shell
+python3 -m pip install IMCtermite
+```
+
+Note, that _python3_setuptools_ and _gcc version >= 10.2.0_ are required to
+successfully install and use it.
+
 ## Usage
 
 ### CLI
 
-The usage of the `imctermite` binary looks like this
+The usage of the `imctermite` binary looks like this:
 
 ```
 imctermite <raw-file> [options]
 ```
 
-since you have to provide a single _raw_ files and any option to specify what
+You have to provide a single _raw_ file and any option to specify what
 to do with the data. All available options can be listed with `imctermite --help`:
 
 ```
@@ -164,14 +178,14 @@ Options:
 ```
 
 For instance, to show a list of all channels included in `sample-data.raw`, you
-do `imctermite sample-data.raw --listchannels`. By default, no output files are
-written but only when an existing (!) directory is provided as argument to
+do `imctermite sample-data.raw --listchannels`. No output files are
+written by default. Output files are written only when an existing (!) directory is provided as argument to
 the `--output` option.
 
 ### Python
 
-Given the `imctermite` module is available we can import it and declare an instance
-of it by passing a _raw_ file to the constructor
+Given the `imctermite` module is available, we can import it and declare an instance
+of it by passing a _raw_ file to the constructor:
 
 ```Python
 import imc_termite
@@ -195,8 +209,13 @@ channels = imcraw.get_channels(False)
 print(channels)
 ```
 
-A more complete example including the methods for obtaining the channels including
-their data and or directly printing them to files can be found at
-[Usage](python/usage.py).
+A more complete [example](python/usage.py), including the methods for obtaining the
+channels, i.a. their data and/or directly printing them to files, can be found
+in the Python folder.
 
 ## References
+
+- https://www.imc-tm.de/produkte/messtechnik-software/imc-famos/funktionen/im-und-export/
+- https://www.imc-tm.de/produkte/messtechnik-hardware/imc-cronosflex/ueberblick/
+- https://cython.readthedocs.io/en/latest/src/userguide/wrapping_CPlusPlus.html
+- https://github.com/Apollo3zehn/ImcFamosFile

cython/imc_termite.pxd

@@ -16,3 +16,4 @@ cdef extern from "imc_raw.hpp" namespace "imc":
     vector[string] get_channels(bool json, bool data) except +
     # print all channels
     void print_channels(string outputdir) except +
+    void print_table(string outputfile) except +

cython/py_imc_termite.pyx

@@ -3,6 +3,7 @@
 from imc_termite cimport imc_termite
 
 import json as jn
+import decimal
 # import numpy as np
 
 cdef class imctermite:
@@ -21,9 +22,21 @@ cdef class imctermite:
   # get JSON list of channels
   def get_channels(self, bool data):
     chnlst = self.cpp_imc.get_channels(True,data)
-    chnlstjn = [jn.loads(chn.decode()) for chn in chnlst]
+    chnlstjn = [jn.loads(chn.decode(errors="ignore"),parse_float=decimal.Decimal) for chn in chnlst]
     return chnlstjn
 
-  # print a channels
+  # print channels
   def print_channels(self, string outputdir):
     self.cpp_imc.print_channels(outputdir)
+
+  # print table including channels
+  def print_table(self, string outputfile):
+    chnlst = self.cpp_imc.get_channels(True,True)
+    chnlstjn = [jn.loads(chn.decode(errors="ignore"),parse_float=decimal.Decimal) for chn in chnlst]
+    with open(outputfile.decode(),'w') as fout:
+      for chn in chnlstjn:
+        fout.write('#' +str(chn['xname']).rjust(19)+str(chn['yname']).rjust(20)+'\n')
+        fout.write('#'+str(chn['xunit']).rjust(19)+str(chn['yunit']).rjust(20)+'\n')
+        for n in range(0,len(chn['ydata'])):
+          fout.write(str(chn['xdata'][n]).rjust(20)+
+                     str(chn['ydata'][n]).rjust(20)+'\n')

cython/setup.py

@@ -14,11 +14,11 @@ extensions = Extension(
 )
 
 setup(
-    version='0.1',
+    name="imc_termite",
+    version='1.2.3',
     description='IMCtermite cython extension',
     author='Record Evolution GmbH',
     author_email='mario.fink@record-evolution.de',
     url='https://github.com/RecordEvolution/IMCtermite.git',
-    name="imc_termite",
     ext_modules=cythonize(extensions,force=True)
 )

lib/imc_channel.hpp

@@ -95,7 +95,7 @@ namespace imc
     ss<<"[";
     if ( myvec.size() <= limit )
     {
-      for ( dt el: myvec ) ss<<el<<",";
+      for ( dt el: myvec ) ss<<std::setprecision(10)<<el<<",";
     }
     else
     {
@@ -104,7 +104,7 @@ namespace imc
       ss<<"...";
       for ( unsigned long int i = myvec.size()-heals; i < myvec.size(); i++ )
       {
-        ss<<myvec[i]<<",";
+        ss<<std::setprecision(10)<<myvec[i]<<",";
       }
     }
     std::string sumstr = ss.str();
@@ -149,7 +149,9 @@ namespace imc
     // constructor takes channel's block environment
     channel(channel_env chnenv, std::map<std::string,imc::block>* blocks,
                                 std::vector<unsigned char>* buffer):
-      chnenv_(chnenv), blocks_(blocks), buffer_(buffer), group_index_(-1)
+      chnenv_(chnenv), blocks_(blocks), buffer_(buffer),
+      factor_(1.), offset_(0.),
+      group_index_(-1)
     {
       // declare list of block parameters
       std::vector<imc::parameter> prms;
@@ -292,6 +294,11 @@ namespace imc
       {
         imc::convert_data_to_type<imc_double>(CSbuffer,ydata_);
       }
+      // ...
+      else if ( datatp_ == 11 )
+      {
+        imc::convert_data_to_type<imc_digital>(CSbuffer,ydata_);
+      }
       else
       {
         throw std::runtime_error(std::string("unsupported/unknown datatype") + std::to_string(datatp_));

lib/imc_conversion.hpp

@@ -17,7 +17,11 @@ namespace imc
     // check number of elements of type "datatype" in buffer
     if ( subbuffer.size() != channel.size()*sizeof(datatype) )
     {
-      throw std::runtime_error("size mismatch between subbuffer and datatype");
+      throw std::runtime_error( std::string("size mismatch between subbuffer (")
+                              + std::to_string(subbuffer.size())
+                              + std::string(") and datatype (")
+                              + std::to_string(channel.size()) + std::string("*")
+                              + std::to_string(sizeof(datatype)) + std::string(")") );
     }
 
     // extract every single number of type "datatype" from buffer
@@ -36,6 +40,8 @@ namespace imc
       // save number in channel
       channel[i] = df;
     }
+
+    // for ( auto el: channel ) std::cout<<el<<"\n";
   }
 
 }

lib/imc_datatype.hpp

@@ -10,31 +10,47 @@ namespace imc
   // map datatype to machine's datatypes
   typedef unsigned char imc_Ubyte;
   typedef signed char imc_Sbyte;
+  //
   typedef unsigned short imc_Ushort;
   typedef signed short imc_Sshort;
+  //
+  // e.g. ARM Cortex-A72 armv7l gcc version 10.2.0 (Ubuntu 10.2.0-13ubuntu1)
+  // #ifdef __arm__
   typedef unsigned long int imc_Ulongint;
   typedef signed long int imc_Slongint;
+  // e.g. Intel(R) Core(TM) i7-3520M CPU @ 2.90GHz x86_64 gcc version 10.2.0 (Ubuntu 10.2.0-13ubuntu1)
+  // #ifdef i386 __i386 __i386__
+  // typedef unsigned int imc_Ulongint;
+  // typedef signed int imc_Slongint;
+  //
   typedef float imc_float;
   typedef double imc_double;
-  // TODO remaining types are not yet supported
+  //
+  // TODO not all remaining types are supported yet
+  // typedef <whatever that is ->... > "imc Devices Transitional Recording"
+  // typedf <sometimestamptype>  "Timestamp Ascii"
+  typedef char16_t imc_digital;
+  // typedef <  > imc_sixbyte "6byte unsigned long"
 
   class datatype
   {
   protected:
-    imc_Ubyte ubyte_;     // 0
-    imc_Sbyte sbyte_;     // 1
-    imc_Ushort ushort_;   // 2
-    imc_Sshort sshort_;   // 3
-    imc_Ulongint ulint_;  // 4
-    imc_Slongint slint_;  // 5
-    imc_float sfloat_;    // 6
-    imc_double sdouble_;  // 7
-    short int dtidx_;     // \in \{0,...,7\}
+    imc_Ubyte ubyte_;      // 0
+    imc_Sbyte sbyte_;      // 1
+    imc_Ushort ushort_;    // 2
+    imc_Sshort sshort_;    // 3
+    imc_Ulongint ulint_;   // 4
+    imc_Slongint slint_;   // 5
+    imc_float sfloat_;     // 6
+    imc_double sdouble_;   // 7
+    imc_digital sdigital_; // 10
+    short int dtidx_;      // \in \{0,...,7,10\}
   public:
     datatype(): ubyte_(0), sbyte_(0),
                 ushort_(0), sshort_(0),
                 ulint_(0.0), slint_(0.0),
                 sfloat_(0.0), sdouble_(0.0),
+                sdigital_(0),
                 dtidx_(0) { };
     // every supported datatype gets its own constructor
     datatype(imc_Ubyte num): ubyte_(num), dtidx_(0) {};
@@ -46,7 +62,10 @@ namespace imc
     datatype(imc_float num): sfloat_(num), dtidx_(6) {};
     datatype(imc_double num): ubyte_(0), sbyte_(0), ushort_(0), sshort_(0),
                               ulint_(0.0), slint_(0.0), sfloat_(0.0), sdouble_(num),
-                              dtidx_(7) {};
+                              sdigital_(0), dtidx_(7) {};
+    datatype(imc_digital num): ubyte_(0), sbyte_(0), ushort_(0), sshort_(0),
+                               ulint_(0.0), slint_(0.0), sfloat_(0.0), sdouble_(num),
+                               sdigital_(num), dtidx_(10) {};
 
     // identify type
     short int& dtype() { return dtidx_; }
@@ -64,6 +83,7 @@ namespace imc
         this->slint_ = num.slint_;
         this->sfloat_ = num.sfloat_;
         this->sdouble_ = num.sdouble_;
+        this->sdigital_ = num.sdigital_;
         this->dtidx_ = num.dtidx_;
       }
 
@@ -119,6 +139,12 @@ namespace imc
       this->dtidx_ = 7;
       return *this;
     }
+    datatype& operator=(const imc_digital &num)
+    {
+      this->sdigital_ = num;
+      this->dtidx_ = 10;
+      return *this;
+    }
 
     // obtain number as double
     double as_double()
@@ -132,6 +158,7 @@ namespace imc
       else if ( dtidx_ == 5 ) num = (double)slint_;
       else if ( dtidx_ == 6 ) num = (double)sfloat_;
       else if ( dtidx_ == 7 ) num = (double)sdouble_;
+      else if ( dtidx_ == 10 ) num = static_cast<double>(sdigital_);
       return num;
     }
 
@@ -146,6 +173,7 @@ namespace imc
       else if ( num.dtidx_ == 5 ) out<<num.slint_;
       else if ( num.dtidx_ == 6 ) out<<num.sfloat_;
       else if ( num.dtidx_ == 7 ) out<<num.sdouble_;
+      else if ( num.dtidx_ == 10 ) out<<static_cast<double>(num.sdigital_);
       return out;
     }
 

lib/imc_raw.hpp

@@ -7,7 +7,7 @@
 #include <filesystem>
 #include <iostream>
 
-#include "hexshow.hpp"
+// #include "hexshow.hpp"
 #include "imc_key.hpp"
 #include "imc_block.hpp"
 #include "imc_datatype.hpp"

makefile

@@ -1,5 +1,7 @@
 #-----------------------------------------------------------------------------#
 
+SHELL := /bin/bash
+
 # name of executable and CLI tool
 EXE = imctermite
 
@@ -17,9 +19,11 @@ CC = g++ -std=c++17
 #OPT = -O3 -Wall -mavx -mno-tbm -mf16c -mno-f16c
 OPT = -O3 -Wall -Werror -Wunused-variable -Wsign-compare
 
-# determine git version/commit tag
+# determine git version/commit and release tag
 GTAG := $(shell git tag | tail -n1)
 GHSH := $(shell git rev-parse HEAD | head -c8)
+RTAG := v$(shell cat pip/setup.py | grep version | grep -oP "([0-9]\.){2}[0-9]")
+CTAG := v$(shell cat cython/setup.py | grep version | grep -oP "([0-9]\.){2}[0-9]")
 
 # define install location
 INST := /usr/local/bin
@@ -28,8 +32,8 @@ INST := /usr/local/bin
 # C++ and CLI tool
 
 # build exectuable
-$(EXE) : main.o
-	$(CC) $(OPT) $^ -o $@
+$(EXE) : check-vtag $(RTAG) main.o
+	$(CC) $(OPT) main.o -o $@
 
 # build main.cpp and include git version/commit tag
 main.o : src/main.cpp $(HPP)
@@ -45,10 +49,22 @@ install : $(EXE)
 uninstall : $(INST)/$(EXE)
 	rm $<
 
-clean :
+cpp-clean :
 	rm -vf $(EXE)
 	rm -vf *.o
 
+#-----------------------------------------------------------------------------#
+# check version consistency of git tags and version string in package.json
+
+$(GTAG) :
+	@echo "consistent versions check successful: building $(GTAG)"
+
+check-vtag:
+	@echo "git tag version:  "$(GTAG)
+	@echo "git commit hash:  "$(GHSH)
+	@echo "release version:  "$(RTAG)
+	@echo "module version:   "$(CTAG)
+
 #-----------------------------------------------------------------------------#
 # Docker
 
@@ -61,48 +77,28 @@ docker-run:
 #-----------------------------------------------------------------------------#
 # python
 
-cython-build : $(CYT)setup.py $(CYT)imc_termite.pxd $(CYT)py_imc_termite.pyx $(HPP)
-	python3 $< build_ext --inplace
+cython-build : check-vtag $(CTAG) $(CYT)setup.py $(CYT)imc_termite.pxd $(CYT)py_imc_termite.pyx $(HPP)
+	python3 $(CYT)setup.py build_ext --inplace
 	cp -v imc_termite.cpython-*.so $(PYT)
 
-cython-install : $(CYT)setup.py $(CYT)imc_termite.pxd $(CYT)py_imc_termite.pyx $(HPP)
-	python3 $< install --record files_imctermite.txt
+cython-install : check-vtag $(CTAG) $(CYT)setup.py $(CYT)imc_termite.pxd $(CYT)py_imc_termite.pyx $(HPP)
+	python3 $(CYT)setup.py install --record files_imctermite.txt
 
 cython-clean :
 	rm -vf imc_termite.cpython-*.so
 	rm -vf $(PYT)imc_termite.cpython-*.so
+	rm -rv build/
 
 #-----------------------------------------------------------------------------#
-# Python (to be removed)
+# pip
 
-# build python module
-py : $(CYT)setup_raw_eater.py $(CYT)raw_eater.pyx $(CYT)raw_eater.pxd $(LIB)raweat.hpp \
-     $(CYT)setup_raw_meat.py $(CYT)raw_meat.pyx $(CYT)raw_meat.pxd $(LIB)rawmerge.hpp \
-		 output
-	python3 $(CYT)setup_raw_eater.py build_ext --inplace
-	python3 $(CYT)setup_raw_meat.py build_ext --inplace
-	cp raw_eater.cpython-*.so $(PYT)
-	cp raw_meat.cpython-*.so $(PYT)
-	rm *.so
-
-py-install: $(CYT)setup_raw_eater.py $(CYT)raw_eater.pyx $(CYT)raw_eater.pxd $(LIB)raweat.hpp \
-            $(CYT)setup_raw_meat.py $(CYT)raw_meat.pyx $(CYT)raw_meat.pxd $(LIB)rawmerge.hpp
-	python3 $(CYT)setup_raw_eater.py install --record files_raw_eater.txt
-	python3 $(CYT)setup_raw_meat.py install --record files_raw_meat.txt
-
-py-clean :
-	rm -f raw_eater.cpython-*.so
-	rm -f $(PYT)raw_eater.cpython-*.so
-	rm -f $(CYT)raw_eater.cpp
-	rm -f raw_meat.cpython-*.so
-	rm -f $(PYT)raw_meat.cpython-*.so
-	rm -f $(CYT)raw_meat.cpp
-	rm -rf build/
-	rm -f *.txt
-	rm -rf output/
-
-# prepare directory for test output
-output :
-	mkdir -pv output/
+pip-release: check-vtag $(RTAG) cython-build
+	cd ./pip/ && make publish
+
+#-----------------------------------------------------------------------------#
+# clean
+
+clean: cpp-clean cython-clean
+	cd ./pip/ && make clean
 
 #-----------------------------------------------------------------------------#

pip/MANIFEST.in

@@ -0,0 +1,4 @@
+include *.hpp
+include *.cpp
+include *.pyx
+include *.pxd

pip/bkup.pyproject.toml

@@ -0,0 +1,4 @@
+[build-system]
+requires = [
+    "setuptools"
+]

pip/makefile

@@ -0,0 +1,26 @@
+# --------------------------------------------------------------------------- #
+
+SHELL := /bin/bash
+
+publish: sdist upload
+
+sdist: ../cython/py_imc_termite.pyx ../cython/imc_termite.pxd ../cython/py_imc_termite.cpp
+	cp -v $? ./
+	cp -v $(shell ls ../lib/imc_*.hpp) ./
+	tail -n 212 ../README.md > ./README.md
+	cp -v ../LICENSE ./
+	python3 setup.py sdist
+
+upload:
+	python3 -m twine upload dist/$(shell ls -t dist/ | head -n1)
+
+clean:
+	rm -rvf dist/
+	rm -rvf *.egg-info
+	rm -rvf build/
+	rm -rvf cython/
+	rm -vf *.pyx *.pxd
+	rm -vf *.cpp *.c *.hpp
+	rm -vf README.md LICENSE
+
+# --------------------------------------------------------------------------- #

pip/setup.py

@@ -0,0 +1,37 @@
+
+from setuptools import setup, Extension
+import os
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name="IMCtermite",
+    version="1.2.3",
+    author="Record Evolution GmbH",
+    author_email="mario.fink@record-evolution.de",
+    maintainer="Record Evolution GmbH",
+    license="MIT",
+    description="Enables extraction of measurement data from binary files with extension 'raw' used by proprietary software imcFAMOS/imcSTUDIO and facilitates its storage in open source file formats",
+    keywords="IMC raw imcFAMOS imcSTUDIO imcCRONOS",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/RecordEvolution/IMCtermite.git",
+    project_urls={
+        "Bug Tracker": "https://github.com/RecordEvolution/IMCtermite/issues",
+    },
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    ext_modules=[Extension("imc_termite",
+                           ["py_imc_termite.cpp"],
+                           # libraries_dirs=["cython/"],
+                           # include_dirs=["3rdparty/pugixml/","lib/"],
+                           # depends=["../lib/tdm_termite.hpp"]
+                           language='c++',
+                           extra_compile_args=['-std=c++17','-Wno-unused-variable'],
+                           extra_link_args=['-std=c++17'],
+                           )],
+)

python/usage.py

@@ -6,7 +6,7 @@ import json
 try :
     imcraw = imc_termite.imctermite(b"samples/sampleA.raw")
 except RuntimeError as e :
-    print("failed to load/parse raw-file: " + str(e))
+    raise Exception("failed to load/parse raw-file: " + str(e))
 
 # obtain list of channels as list of dictionaries (without data)
 channels = imcraw.get_channels(False)
@@ -23,3 +23,6 @@ print(len(chnxdata))
 
 # print the channels into a specific directory
 imcraw.print_channels(b"./")
+
+# print all channels in single file
+imcraw.print_table(b"./allchannels.csv")

python/usage_adv.py

@@ -0,0 +1,32 @@
+
+import imc_termite
+import json
+import glob
+import os
+from pathlib import Path
+
+# list files in sample directory
+# fileobj1 = Path("samples/").rglob("*.raw")
+# rawlist1 = [str(fl) for fl in fileobj1]
+rawlist1 = ["samples/datasetB/datasetB_29.raw"]
+print(rawlist1)
+
+for fl in rawlist1:
+
+    print("converting " + str(fl) + " : " + str(os.path.basename(fl)) )
+
+    # declare and initialize instance of "imctermite" by passing a raw-file
+    try :
+        imcraw = imc_termite.imctermite(fl.encode())
+    except RuntimeError as e :
+        raise Exception("failed to load/parse raw-file: " + str(e))
+
+    # obtain list of channels as list of dictionaries (without data)
+    channels = imcraw.get_channels(False)
+    print(json.dumps(channels,indent=4, sort_keys=False))
+
+    # print the channels into a specific directory
+    imcraw.print_channels(b"./")
+
+    # print all channels in single file
+    imcraw.print_table(("./"+str(os.path.basename(fl).split('.')[0])+"_allchannels.csv").encode())