root/library/doc/tutorial/000install.dox @ 974

Revision 948, 4.4 kB (checked in by smidl, 14 years ago)

doc

Line 
1/*!
2\page install BDM Use - Installation
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.
10
11\section in_bin Binaries for BDMtoolbox
12Binaries for the matlab BDMtoolbox are available only for windows (win32) platform, compiled against matlab 7.1 for compatibility.
13
14Installation:
15\li svn checkout http://mys.utia.cas.cz:1800/svn/mixpp/applications/bdmtoolbox/ into your local directory of your choice (this will be denoted \<toolbox_dir\>)
16\li or download a prepared zip file from http://staff.utia.cas.cz/smidl/Public/bdmtoolbox_win32.zip and extract it to any directory (will be denoted \<toolbox_dir\>)
17\li open matlab and type:
18\code
19>> addpath <toolbox_dir>/mex;
20>> addpath <toolbox_dir>/mexw32
21>> addpath <toolbox_dir>/mex_classes
22\endcode
23for downloaded win32 version of the toolbox. When compiling from sources, the mex files may be located in Debug of Release directories. Check where
24        the latest compiled files are and add apropriate path. E.g. for Windown and Mac:
25\code
26>> addpath <toolbox_dir>/mex;
27>> addpath <toolbox_dir>/mex/Debug;
28>> addpath <toolbox_dir>/mex_classes
29\endcode
30For linux, the default build dir is \<toolbox_dir\>/mex, hence only me and mex_classes need to be in the path.
31\li the toolbox is ready to be used, test it e.g. by:
32\code >> cd tutorial/userguide;
33>> pdfds_example \endcode
34\li if no error is given, the toolbox is installed correctly
35\li proceed to tutorial at http://mys.utia.cas.cz:1800/trac/bdm/doxygen/pages.html to learn how to use it
36
37\section src Source code
38
39is available from svn repository:
40http://mys.utia.cas.cz:1800/svn/mixpp using guest/guest as login/password.
41
42For download use an appropriate SVN client http://subversion.tigris.org/links.html#clients
43
44Download the source files to any directory of your choise, this directoory will be refered to as \<bdm_dir\>.
45
46\subsection pre Prerequisities
47
48You need to have the following tools available on your system:
49\li working C++ compiler, e.g. gcc on Linux, or Visual Studio on windows
50\li CMake, a cross-platform build system, http://www.cmake.org
51 
52\section lin Linux
53
54All prerequisities are available as binary packages for most distribution. E.g. for debian-based distributions, use
55\code
56apt-get install g++ cmake
57\endcode
58
59Compile the BDM library and its applications using
60\code
61$ cd <bdm_dir>/library/
62$ cmake .
63$ make
64\endcode
65
66
67\section win Windows
68
69The following approach was tested on the Microsoft Visual Studio 9.
70
71Make sure you have cmake installed.
72
73We are including latest stable code from IT++ which requires a implementation of BLAS and LAPACK routines.
74The most convenient library is ACML which can be downloaded from AMD.
75
76For convenience of the beginners, DLLS of the ACML and lib+include files for ITPP and ACML are
77provided at: http://staff.utia.cas.cz/smidl/Public/mixpp_win32lib.zip
78If you want to use them copy the content of the zip file to \<bdm_dir\>/library/system/win32/ directory and
79make sure to set your PATH environment variable:
80\code
81 Path = %PATH%; <bdm_dir>\library\system\win32\dll
82\endcode
83
84Be sure to set system variable globally, i.e., through the dialog box "System Properties",
85tab "Advanced" and button "Environment Variables". Otherwise you will not be able to run
86any programs.
87
88
89Compilation of BDM:
90
91 * When everything is set-up, make a copy of library\system\win32\run_cmake.bat, edit it
92  to reflect your environment (i.e. change paths to cmake and your C++ target environment)
93  and run it.
94
95 * Alternatively, you can run CMake GUI and specify address to your \<bdm_dir\>
96
97
98 * It should generate build files for your compiler in the main BDM
99  directory
100
101For more comfortable work with Subversion, we recommend to install also AnkhSVN -
102a Visual Studio plug-in that perfectly integrates Subversion into the GUI, see http://ankhsvn.open.collab.net/
103
104
105\section mac Mac OS X
106
107All prerequisities for Mac OS X are avaliable, make sure you have them installed.
108
109Right now, Cmake configuration is hard-coded for one testing machine. Look for the paths in SetBDMEnv.cmake and correct them.
110Open CMake GUI, clisk Configure followed by Create.
111Configuration files for your favourite build environment should be created in the BDM directory.
112
113*/
Note: See TracBrowser for help on using the browser.