/mi-toolchain

Machine Intelligence Core: Toolchain. A sub-project of Machine Intelligence Core, being the real "core" of the framework. Contains tools required for development of MIC-based applications, such as configuration management, loggers, application state etc.

Primary LanguageC++Apache License 2.0Apache-2.0

Machine Intelligence Core: Toolchain

Language GitHub license Build Status Total alerts Language grade: C/C++

Description

A subproject of Machine Intelligence Core, being the real "core" of the framework.

Contains tools required for development of MIC-based applications, such as configuration management, loggers, application state etc.

MIC dependencies

  • none

External dependencies

Toolchain depends on the following external libraries:

  • Boost - a library of free (open source) peer-reviewed portable C++ source libraries.

Installation of the dependencies/required tools

On Linux (Ubuntu 14.04):

sudo apt-get install git cmake doxygen libboost1.54-all-dev

Main modules

  • application - classes related for management of applications, their state, key-handlers as well application factories.
  • configuration - classes responsible for configuration management (parameters server, property tree etc.)
  • logger - classes and functions related to logger

Applications

  • logger_test - application for testing console logger.

Installation

In order to download, configure, make and install new "clean" version of mi-toolchain please execute the following:

cd ~/workspace
git clone git@github.com:ibm/mi-toolchain.git
cd mi-toolchain
mkdir build
cd build
cmake .. -DCMAKE_INSTALL_PREFIX=~/workspace/mic/
make -j4 install

Documentation

In order to generate a "living" documentation of the code please run Doxygen:

cd ~/workspace/mi-toolchain
doxygen mi-toolchain.doxyfile
firefox html/index.html

The current documentation (generated straight from the code and automatically uploaded to GH pages by Travis) is available at:

https://ibm.github.io/mi-toolchain/

Maintainer

Tomasz Kornuta (tkornut@us.ibm.com)