root/library/doc/local/install.dox @ 590

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