root/applications/bdmtoolbox/doc/local/000install.dox @ 1440

Revision 1044, 4.2 kB (checked in by smidl, 14 years ago)

Tutorial moved to bdmtoolbox

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