INSTALL.md

Installation instructions for nn-simulator

Disclaimer

This program is written in C++, and built using CMake.
To build, you will need to have the following utilities and libraries installed:

• A C compiler such as gcc or clang.
• A C++ compiler such a g++ or clang.
• Boost libraries (http://www.boost.org/) version 1.49.0 or higher.
• CMake (http://www.cmake.org/cmake/resources/software.html) build utility. Optionally install:
• lcov if you wish to generate lcov coverage reports.
• cobertura,python,gcovr if you wish to generate cobertura coverage reports (for jenkins).

Building

1. Run "mkdir build"
2. Run "cd build"
3. Run "cmake .." to create the Makefile.
4. Run "make" to build.

Installation

Once built:

• Run "make install" to install.

Testing

1. Run "mkdir build"
2. Run "cd build"
3. Run "cmake -D TESTING=FAST .." to create the Makefile with most tests enabled, or run "cmake -D TESTING=ALL .." to enable integration tests as well.
4. Run "make" to build.
5. Run "make test" to run tests.

Coverage reports

1. Run "mkdir build"
2. Run "cd build"
3. Run "cmake .. -DCOVERAGE=LCOV -DTESTING=ALL" to create the Makefile and output using lcov, or "cmake .. -DCOVERAGE=COBERTURA -DTESTING=ALL" to use cobertura instead.
4. Run "make" to build.
5. Run "make coverage" to run tests and generate a coverage report.

Running

Run "./nn-simulator" to run the program from within the build directory, or if installed, just run "nn-simulator".