Read Me

Introduction
----------
iqr is a simulation software to design and control large-scale neuronal models with a graphical
interface. The modelled systems can be connected to various hardware devices, e.g. to
control the behavior of a robot or read input from a camera. 


iqr versions
------------
The sources of iqr 1.x are in the 'src' directory. The directory 'src-qt4' contains iqr
version 2.x which is ported to qt 4

Requirements
----------
on LINUX:
to compile iqr, you need the standard compile suite for c++ (gcc-c++, libstdc++, etc), 
cmake, and the following devel packages:
(only for iqr < 2.3.0 - Xerces-c version 2.7 (http://xerces.apache.org/xerces-c/))
- qt (http://qt.nokia.com/products) (version 3.x for iqr 1.x, version >=4.5 for iqr 2.x)

on WINDOWS:
- cmake (http://www.cmake.org)
- MinGW/MSys (http://www.mingw.org/)
  - add <MinGWDIR>\bin and <MinGWDIR>\MinGW\msys\1.0\bin to your PATH environment variable
- pthreads (http://sourceware.org/pthreads-win32/)
  - please install pthreads headers in C:/pthreads.2 (if they are in a different location you have to change CMakeList.txt)
  - recompile pthreads with 'make clean GCE-inlined'
  - set the environment variable LIBRARY_PATH to include the directory where libpthreadGCE2.a is
- OpenCV (http://opencv.willowgarage.com/wiki/)
  - get and recompile opencv 
  - if problems with compiling opencv, get the latest version of libvideoInput.a from here: https://github.com/Kronen/Qt-OpenCv/lib/
  - add <OpenCVDIR>\lib to the LIBRARY_PATH environment variable
- Qt
  - add <QTDIR>\qt\qmake to your PATH environment variable
  - if you have problems with the qt install dirs: run configure in the <QTDIR>\qt (e.g. C:\Qt\2010.05\qt)
- if you want to create an installer: NSIS (http://nsis.sourceforge.net/)
- (only for iqr < 2.3.0: recompile 'xerces-c' with MinGW)

  
Compiling iqr
----------
on LINUX:
- to generate the Makefiles run 'cmake .' in the 'src' directory
- run 'make

on WINDOWS:
- open the source dir of iqr with cmake-gui (e.g. C:\Users\Ulysses\Desktop\iqr\trunk\src-qt4)
- in cmake-gui select 'MSYS Makefile' generator
- click on 'Configure', and if that is successfull 'Generate'
- open a shell in source dir of iqr and type 'make'
  

  Installation
------------
The best way is to create installation packages, and then install them:
- creating packages
  - for creating packages, we use CPack, integrated with CMake
  - 'make package' will create RPM and DEB packages on Linux, and an NSIS installer on Windows

- alternatively iqr can be installed system wide with 'make install' 
- if you do not use 'make install':
  you'll have to set the environment variable 'LD_LIBRARY_PATH' (on Linux) to
  include the '../lib' directory. This can be done by e.g. adding 'export
  LD_LIBRARY_PATH=$LD_LIBRARY_PATH:~/home/iqr/lib' to ~/.bashrc. The executable (iqr) resides in 'bin/'