Changeset 302 for doc/local

Show
Ignore:
Timestamp:
03/19/09 16:34:17 (16 years ago)
Author:
smidl
Message:

Install manual ticket #17

Location:
doc/local
Files:
3 modified

Legend:

Unmodified
Added
Removed

  • doc/local/install.dox

    r298 r302  
    66 
    77BDM 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  
    16 Distribution of the binary form is not currently available.  
     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. 
    1711 
    1812 
    … …  
    2721 
    2822You 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. 
     23\li working C++ compiler, e.g. gcc on Linux, or Visual Studio on windows 
     24\li CMake, a cross-platform build system, http://www.cmake.org 
     25\li ITPP library, http://itpp.sourceforge.net/ which is a part of all major linux distributions, for its installation on Windows, see Section Windows. 
    3226  
    33 \subsection lin Linux 
     27\section lin Linux 
    3428 
    3529All prerequisities are available as binary packages for most distribution. E.g. for debian-based distributions, use 
    … …  
    4539\endcode 
    4640 
    47 \subsection win Windows 
     41 
     42\section win Windows 
    4843 
    4944The following approach was tested on Visual Studio 9, so we recommend to download and install it.  
    … …  
    6055make sure to set your PATH environment variable: 
    6156\code 
    62  Path = %PATH%; <mixpp_dir>\win32\dll 
    63  \endcode 
     57 Path = %PATH%; <bdm_dir>\win32\dll 
     58\endcode 
    6459Otherwise you will not be able to run any programs. 
    6560 
    … …  
    7469  directory 
    7570 
     71\section mac Mac OS X 
     72 
     73All prerequisities for Mac OS X are avaliable except for ITPP, make sure you have them installed. 
     74 
     75However, its compilation is straightforward.  
     76 
     77 1. Download the latest stable release from http://itpp.sourceforge.net 
     78 2. Compile it using script mac/itpp_compile.sh 
     79 
     80The default cmake configuration is looking for itpp in directory mac/itpp, make sure you have symlinks to this directory. 
     81 
     82If itpp compilation is successfull, you can run Cmake. Fill in the paths to your BDM directory, run Configure followed by Create. 
     83Configuration files for your favourite build environment should be created in the BDM directory. 
    7684 
    7785*/ 

  • doc/local/install.dox~

    r298 r302  
    66 
    77BDM 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  
    16 Distribution of the binary form is not currently available.  
     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. 
    1711 
    1812 
    … …  
    2721 
    2822You 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. 
     23\li working C++ compiler, e.g. gcc on Linux, or Visual Studio on windows 
     24\li CMake a cross-platform build system, http://www.cmake.org 
     25\li ITPP library, http://itpp.sourceforge.net/ which is a part of all major linux distributions, for its installation on Windows, see Section Windows. 
    3226  
    33 \subsection lin Linux 
     27\section lin Linux 
    3428 
    3529All prerequisities are available as binary packages for most distribution. E.g. for debian-based distributions, use 
    … …  
    4539\endcode 
    4640 
    47 \subsection win Windows 
     41 
     42\section win Windows 
    4843 
    4944The following approach was tested on Visual Studio 9, so we recommend to download and install it.  
    … …  
    6156\code 
    6257 Path = %PATH%; <mixpp_dir>\win32\dll 
    63  \endcode 
     58\endcode 
    6459Otherwise you will not be able to run any programs. 
    6560 
    6661 
    6762Compilation of BDM: 
     63 
    6864 * When everything is set-up, make a copy of win32/run_cmake.bat, edit it  
    6965  to reflect your environment (i.e. change paths to cmake and your C++ target environment)  
    7066  and run it. 
     67 
    7168 * It should generate build files for your compiler in the main BDM  
    7269  directory 
    7370 
     71\section mac Mac OS X 
     72 
     73All prerequisities for Mac OS X are avaliable except for ITPP, make sure you have them installed. 
     74 
     75However, its compilation is straightforward.  
     76 
     77 1. Download the latest stable release from http://itpp.sourceforge.net 
     78 2. Compile it using script mac/itpp_compile.sh 
     79 
     80The default cmake configuration is looking for itpp in directory mac/itpp, make sure you have symlinks to this directory. 
     81 
     82If itpp compilation is successfull, you can run Cmake. Fill in the paths to your BDM directory, run Configure followed by Create. 
     83Configuration files for your favourite build environment should be created in the BDM directory. 
    7484 
    7585*/ 

  • doc/local/mainpage.dox

    r167 r302  
    88BDM is a collection of methods for selected tasks of Bayesian decision-making, such as estimation, filtering and control. 
    99 
    10 \section Approach 
    11 The toolbox is designed using two design criteria: 
     10\section fea Features 
     11At present the following algorithms are implemented: 
     12- \b Bayesian \b filtering : Kalman filter, EKF, patricle filter (PF), 
     13    - these can be combined mutualy together in mode demanding schemes, see marginalized particle filter MPF 
     14 
     15- \b Classification using mixtures of exponential famiuly models (MixEF), 
     16- \b Density \b estimation : using mixtures (MixEF), density composition (merger) 
     17 
     18\section down Download and Use 
     19The library is available under GPL, see installation instructions on page \ref install 
     20 
     21Precompiled Mex files for use within Matlab are available \ref mexfiles 
     22 
     23\section app Design Approach 
     24The toolbox is designed using \b object-oriented approach with two design criteria: 
    1225\li relation to mathematics, 
    1326\li efficient evaluation, 
    1427while the first one is more important than the latter. 
    1528 
    16 Hence, each mathematical object such as probability density is represented by one software object. The resulting algorithms are then implemented as operations on these objects. In cases when more efficient solution can be achived when this structure is not respected, a parallel implementation is created and clearly marked as specific.  
     29Hence, each mathematical object such as probability density is  
     30represented by one software object. The resulting algorithms are  
     31then implemented as operations on these objects. In cases when  
     32more efficient solution can be achived when this structure is not respected,  
     33a parallel implementation is created and clearly marked as specific.  
    1734 
    18 \section Methods 
    19 At present we support the following methods: 
    20 \li Estimation: ARX models  
    21 \li Filtering: Kalman filtering, Extended %Kalman filters (EKF), Particle filters (PF), Marginalized Particle filters (MPF). 
    22 \li Desing: None. 
     35OpenMP is used to achive efficient implementation on parallel architectures. 
    2336 
    24 \section Implementation 
     37\section impl Implementation 
    2538 
    2639 BDM is build on top of \c IT++ which wraps numerically efficient operations of linear algebra into easy to use C++ classes. Thanks to this excellent library, writing of numerical algorithms is as easy as in Matlab but we gain significant advantages: 
    … …  
    3245 
    3346 
    34  
    3547*/