[298] | 1 | /*! |
---|
[632] | 2 | \page install BDM Use - Installation |
---|
[298] | 3 | |
---|
| 4 | BDM is written as a multiplatform library, which was tested on Linux, Windows and Mac OSX. |
---|
| 5 | However, installation on each platform is specific. |
---|
| 6 | |
---|
| 7 | BDM comes in two basic versions: |
---|
[302] | 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. |
---|
[298] | 10 | |
---|
[778] | 11 | \section in_bin Binaries for BDMtoolbox |
---|
| 12 | Binaries for the matlab BDMtoolbox are available only for windows (win32) platform, compiled against matlab 7.1 for compatibility. |
---|
[298] | 13 | |
---|
[778] | 14 | Installation: |
---|
| 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 open matlab and type: \>\> addpath \<toolbox_dir\>/mex; addpath \<toolbox_dir\>/mexw32 |
---|
| 17 | \li the toolbox is ready to be used, test it e.g. by: \>\> cd tutorial/userguide; pdfds_example |
---|
| 18 | \li if no error is given, the toolbox is installed correctly |
---|
| 19 | \li proceed to http://mys.utia.cas.cz:1800/trac/bdm/doxygen/pages.html to learn how to use it |
---|
| 20 | |
---|
[298] | 21 | \section src Source code |
---|
| 22 | |
---|
| 23 | is available from svn repository: |
---|
[590] | 24 | http://mys.utia.cas.cz:1800/svn/mixpp using guest/guest as login/password. |
---|
[298] | 25 | |
---|
| 26 | For download use an appropriate SVN client http://subversion.tigris.org/links.html#clients |
---|
| 27 | |
---|
[377] | 28 | Download the source files to any directory of your choise, this directoory will be refered to as \<bdm_dir\>. |
---|
[353] | 29 | |
---|
[298] | 30 | \subsection pre Prerequisities |
---|
| 31 | |
---|
| 32 | You need to have the following tools available on your system: |
---|
[302] | 33 | \li working C++ compiler, e.g. gcc on Linux, or Visual Studio on windows |
---|
| 34 | \li CMake, a cross-platform build system, http://www.cmake.org |
---|
| 35 | \li ITPP library, http://itpp.sourceforge.net/ which is a part of all major linux distributions, for its installation on Windows, see Section Windows. |
---|
[298] | 36 | |
---|
[302] | 37 | \section lin Linux |
---|
[298] | 38 | |
---|
| 39 | All prerequisities are available as binary packages for most distribution. E.g. for debian-based distributions, use |
---|
| 40 | \code |
---|
| 41 | apt-get install g++ cmake libitpp-dev |
---|
| 42 | \endcode |
---|
| 43 | |
---|
[305] | 44 | \note If you want to use mex files, you need to build IT++ from sources using the classi configure;make;make install. |
---|
| 45 | The necessary flags for configure for mex compilation are in file linux/configure_itpp. |
---|
| 46 | |
---|
[298] | 47 | Compile the BDM library and its applications using |
---|
| 48 | \code |
---|
[594] | 49 | $ cd <bdm_dir>/library/ |
---|
[298] | 50 | $ cmake . |
---|
| 51 | $ make |
---|
| 52 | \endcode |
---|
| 53 | |
---|
| 54 | |
---|
[302] | 55 | \section win Windows |
---|
| 56 | |
---|
[711] | 57 | The following approach was tested on the Microsoft Visual Studio 9. |
---|
[298] | 58 | |
---|
| 59 | Make sure you have cmake installed. |
---|
| 60 | |
---|
| 61 | Expert users are advised to download and compile their ITPP version following a guide on : |
---|
| 62 | http://itpp.sourceforge.net/current/installation.html |
---|
| 63 | |
---|
| 64 | For convenience of the beginners, DLLS of the ACML and lib+include files for ITPP and ACML are |
---|
| 65 | provided at: http://staff.utia.cas.cz/smidl/Public/mixpp_win32lib.zip |
---|
[594] | 66 | If you want to use them copy the content of the zip file to \<bdm_dir\>/library/system/win32/ directory and |
---|
[298] | 67 | make sure to set your PATH environment variable: |
---|
| 68 | \code |
---|
[594] | 69 | Path = %PATH%; <bdm_dir>\library\system\win32\dll |
---|
[302] | 70 | \endcode |
---|
[298] | 71 | |
---|
[643] | 72 | Be sure to set system variable globally, i.e., through the dialog box "System Properties", |
---|
| 73 | tab "Advanced" and button "Environment Variables". Otherwise you will not be able to run |
---|
| 74 | any programs. |
---|
[298] | 75 | |
---|
[643] | 76 | |
---|
[298] | 77 | Compilation of BDM: |
---|
| 78 | |
---|
[594] | 79 | * When everything is set-up, make a copy of library\system\win32\run_cmake.bat, edit it |
---|
[298] | 80 | to reflect your environment (i.e. change paths to cmake and your C++ target environment) |
---|
| 81 | and run it. |
---|
| 82 | |
---|
| 83 | * It should generate build files for your compiler in the main BDM |
---|
| 84 | directory |
---|
| 85 | |
---|
[747] | 86 | For more comfortable work with Subversion, we recommend to install also AnkhSVN - |
---|
| 87 | a Visual Studio plug-in that perfectly integrates Subversion into the GUI, see http://ankhsvn.open.collab.net/ |
---|
[711] | 88 | |
---|
| 89 | |
---|
[302] | 90 | \section mac Mac OS X |
---|
[298] | 91 | |
---|
[302] | 92 | All prerequisities for Mac OS X are avaliable except for ITPP, make sure you have them installed. |
---|
| 93 | |
---|
| 94 | However, its compilation is straightforward. |
---|
| 95 | |
---|
| 96 | 1. Download the latest stable release from http://itpp.sourceforge.net |
---|
[353] | 97 | 2. Compile it using script system/mac/itpp_compile.sh |
---|
[302] | 98 | |
---|
| 99 | The default cmake configuration is looking for itpp in directory mac/itpp, make sure you have symlinks to this directory. |
---|
| 100 | |
---|
| 101 | If itpp compilation is successfull, you can run Cmake. Fill in the paths to your BDM directory, run Configure followed by Create. |
---|
| 102 | Configuration files for your favourite build environment should be created in the BDM directory. |
---|
| 103 | |
---|
[298] | 104 | */ |
---|