root/doc/local/install.dox @ 298

Revision 298, 2.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<dl>
9 <dt> binary  <dd> with precompiled executables and matlab mex files that can be configured by external text files
10 <dt> source code <dd>  that can be compiled into any required form.
11 
12</dl>
13 
14\section bin Binary form
15
16Distribution of the binary form is not currently available.
17
18
19\section src Source code
20
21is available from svn repository:
22http://mys.utia.cas.cz:1800/svn/mixpp
23
24For download use an appropriate SVN client http://subversion.tigris.org/links.html#clients
25
26\subsection pre Prerequisities
27
28You need to have the following tools available on your system:
29 * working C++ compiler, e.g. gcc on Linux, or Visual Studio on windows
30 * CMake a cross-platform build system, http://www.cmake.org
31 * ITPP library, http://itpp.sourceforge.net/ which is a part of all major linux distributions, for its installation on Windows, see Section Windows.
32 
33\subsection lin Linux
34
35All prerequisities are available as binary packages for most distribution. E.g. for debian-based distributions, use
36\code
37apt-get install g++ cmake libitpp-dev
38\endcode
39
40Compile the BDM library and its applications using
41\code
42$ cd directory/with/bdm/sources
43$ cmake .
44$ make
45\endcode
46
47\subsection 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 win32\ directory and
60make sure to set your PATH environment variable:
61\code
62 Path = %PATH%; <mixpp_dir>\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 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
77*/
Note: See TracBrowser for help on using the browser.