READ Modules

READ Modules are document analysis modules developed at CVL/TU Wien for the EU project READ. The READ project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 674943.

Documentation can be found here: http://read-api.caa.tuwien.ac.at/ReadModules/

Build on Windows

todo

Build on Ubuntu

note that Qt 5.5 is needed, thus Ubuntu version must be >= 16.04 or backports of Qt 5.5 have to be used (see .travis.yml for an ppa repository and names packages which need to be installed)

Get required packages:

sudo apt-get install qt5-qmake qttools5-dev-tools qt5-default libqt5svg5-dev qt5-image-formats-plugins libopencv-dev cmake git libexiv2-dev libraw-dev

Get nomacs sources from github:

git clone https://github.com/nomacs/nomacs

This will by default place the source into ./nomacs Go to the nomacs directory and run cmake to get the Makefiles:

cd nomacs
cmake ImageLounge/.

Compile nomacs:

make

Get the READ Framework sources from github:

git clone https://github.com/TUWien/ReadFramework

This will by default place the source into ./ReadFramework

Go to the ReadFramework directory and run cmake to get the Makefiles:

cd ReadFramework
cmake .

Compile READ Framework:

make

Get the READ Modules sources from github:

git clone https://github.com/TUWien/ReadModules

This will by default place the source into ./ReadModules

Go to the ReadModules directory and run cmake to get the Makefiles: you have to set the correct nomacs and ReadFramework build directories

cd ReadModules
cmake -Dnomacs_DIR=../nomacs/ -DReadFramework_DIR=../ReadFramework .

Compile READ Modules:

make

The READ modules are nomacs plugins which will be automatically copied to the nomacs build directory after compiling. Go to the nomacs build directory and start nomacs

./nomacs

The READ modules are now available in the Menu -> Plugins (you have to execute the PluginManager once from the menu)

you can also use

sudo make install

and the plugins will be copied into /usr/local/lib/nomacs-plugins and should be found by the installed nomacs

authors

Markus Diem Stefan Fiel Florian Kleber

related links:

[1] https://cvl.tuwien.ac.at/

[2] https://transkribus.eu/Transkribus/

[3] https://github.com/TUWien/

[4] http://nomacs.org