root/library/doc/local/install.dox~ @ 445

Revision 305, 3.2 kB (checked in by smidl, 16 years ago)

doc

Line 
1/*!
2\page install How to install BDM
3
4BDM is written as a multiplatform library, which was tested on Linux, Windows and Mac OSX.
5However, installation on each platform is specific.
6
7BDM comes in two basic versions:
8\li \b binary   with precompiled executables and matlab mex files that can be configured by external text files
9\li \b source \b code  that can be compiled into any required form.
10Distribution of the binary form is not currently available. It is planned in latter stages of development.
11
12
13\section src Source code
14
15is available from svn repository:
16http://mys.utia.cas.cz:1800/svn/mixpp
17
18For download use an appropriate SVN client http://subversion.tigris.org/links.html#clients
19
20\subsection pre Prerequisities
21
22You need to have the following tools available on your system:
23\li working C++ compiler, e.g. gcc on Linux, or Visual Studio on windows
24\li CMake, a cross-platform build system, http://www.cmake.org
25\li ITPP library, http://itpp.sourceforge.net/ which is a part of all major linux distributions, for its installation on Windows, see Section Windows.
26 
27\section lin Linux
28
29All prerequisities are available as binary packages for most distribution. E.g. for debian-based distributions, use
30\code
31apt-get install g++ cmake libitpp-dev
32\endcode
33
34\note If you want to use mex files, you need to build IT++ from sources using the classi configure;make;make install.
35The necessary flags for configure for mex compilation are in file linux/configure_itpp.
36
37
38Compile the BDM library and its applications using
39\code
40$ cd directory/with/bdm/sources
41$ cmake .
42$ make
43\endcode
44
45
46\section win Windows
47
48The following approach was tested on Visual Studio 9, so we recommend to download and install it.
49http://www.microsoft.com/express/vc/
50
51Make sure you have cmake installed.
52
53Expert users are advised to download and compile their ITPP version following a guide on :
54http://itpp.sourceforge.net/current/installation.html
55
56For convenience of the beginners, DLLS of the ACML and lib+include files for ITPP and ACML are
57provided at: http://staff.utia.cas.cz/smidl/Public/mixpp_win32lib.zip
58If you want to use them copy the content of the zip file to win32\ directory and
59make sure to set your PATH environment variable:
60\code
61 Path = %PATH%; <bdm_dir>\win32\dll
62\endcode
63Otherwise you will not be able to run any programs.
64
65
66Compilation of BDM:
67
68 * When everything is set-up, make a copy of win32/run_cmake.bat, edit it
69  to reflect your environment (i.e. change paths to cmake and your C++ target environment)
70  and run it.
71
72 * It should generate build files for your compiler in the main BDM
73  directory
74
75\section mac Mac OS X
76
77All prerequisities for Mac OS X are avaliable except for ITPP, make sure you have them installed.
78
79However, its compilation is straightforward.
80
81 1. Download the latest stable release from http://itpp.sourceforge.net
82 2. Compile it using script mac/itpp_compile.sh
83
84The default cmake configuration is looking for itpp in directory mac/itpp, make sure you have symlinks to this directory.
85
86If itpp compilation is successfull, you can run Cmake. Fill in the paths to your BDM directory, run Configure followed by Create.
87Configuration files for your favourite build environment should be created in the BDM directory.
88
89*/
Note: See TracBrowser for help on using the browser.