Show
Ignore:
Timestamp:
10/12/09 13:49:39 (15 years ago)
Author:
mido
Message:

\doc directory cleaned a bit

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • library/doc/html/install.html

    r641 r651  
    1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
    2 <html xmlns="http://www.w3.org/1999/xhtml"> 
    3 <head> 
    4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 
     1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 
     2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 
    53<title>mixpp: BDM Use - Installation</title> 
    6 <link href="tabs.css" rel="stylesheet" type="text/css"/> 
    7 <link href="doxygen.css" rel="stylesheet" type="text/css"/> 
    8 </head> 
    9 <body> 
    10 <!-- Generated by Doxygen 1.6.1 --> 
     4<link href="tabs.css" rel="stylesheet" type="text/css"> 
     5<link href="doxygen.css" rel="stylesheet" type="text/css"> 
     6</head><body> 
     7<!-- Generated by Doxygen 1.5.9 --> 
    118<script type="text/javascript"> 
    129<!-- 
     
    6158</div> 
    6259<div class="contents"> 
    63  
    64  
    65 <h1><a class="anchor" id="install">BDM Use - Installation </a></h1><p>BDM is written as a multiplatform library, which was tested on Linux, Windows and Mac OSX. However, installation on each platform is specific.</p> 
    66 <p>BDM comes in two basic versions: </p> 
    67 <ul> 
     60<h1><a class="anchor" name="install">BDM Use - Installation </a></h1>BDM is written as a multiplatform library, which was tested on Linux, Windows and Mac OSX. However, installation on each platform is specific.<p> 
     61BDM comes in two basic versions: <ul> 
    6862<li><b>binary</b> with precompiled executables and matlab mex files that can be configured by external text files </li> 
    6963<li><b>source</b> <b>code</b> that can be compiled into any required form. Distribution of the binary form is not currently available. It is planned in latter stages of development.</li> 
    7064</ul> 
    71 <h2><a class="anchor" id="src"> 
     65<h2><a class="anchor" name="src"> 
    7266Source code</a></h2> 
    73 <p>is available from svn repository: <a href="http://mys.utia.cas.cz:1800/svn/mixpp">http://mys.utia.cas.cz:1800/svn/mixpp</a> using guest/guest as login/password.</p> 
    74 <p>For download use an appropriate SVN client <a href="http://subversion.tigris.org/links.html#clients">http://subversion.tigris.org/links.html#clients</a></p> 
    75 <p>Download the source files to any directory of your choise, this directoory will be refered to as &lt;bdm_dir&gt;.</p> 
    76 <h3><a class="anchor" id="pre"> 
     67is available from svn repository: <a href="http://mys.utia.cas.cz:1800/svn/mixpp">http://mys.utia.cas.cz:1800/svn/mixpp</a> using guest/guest as login/password.<p> 
     68For download use an appropriate SVN client <a href="http://subversion.tigris.org/links.html#clients">http://subversion.tigris.org/links.html#clients</a><p> 
     69Download the source files to any directory of your choise, this directoory will be refered to as &lt;bdm_dir&gt;.<h3><a class="anchor" name="pre"> 
    7770Prerequisities</a></h3> 
    78 <p>You need to have the following tools available on your system: </p> 
    79 <ul> 
     71You need to have the following tools available on your system: <ul> 
    8072<li>working C++ compiler, e.g. gcc on Linux, or Visual Studio on windows </li> 
    8173<li>CMake, a cross-platform build system, <a href="http://www.cmake.org">http://www.cmake.org</a> </li> 
    8274<li>ITPP library, <a href="http://itpp.sourceforge.net/">http://itpp.sourceforge.net/</a> which is a part of all major linux distributions, for its installation on Windows, see Section Windows.</li> 
    8375</ul> 
    84 <h2><a class="anchor" id="lin"> 
     76<h2><a class="anchor" name="lin"> 
    8577Linux</a></h2> 
    86 <p>All prerequisities are available as binary packages for most distribution. E.g. for debian-based distributions, use </p> 
    87 <div class="fragment"><pre class="fragment">apt-<span class="keyword">get</span> install g++ cmake libitpp-dev  
    88 </pre></div><dl class="note"><dt><b>Note:</b></dt><dd>If you want to use mex files, you need to build IT++ from sources using the classi configure;make;make install. The necessary flags for configure for mex compilation are in file linux/configure_itpp.</dd></dl> 
    89 <p>Compile the BDM library and its applications using </p> 
    90 <div class="fragment"><pre class="fragment">$ cd &lt;bdm_dir&gt;/library/ 
     78All prerequisities are available as binary packages for most distribution. E.g. for debian-based distributions, use <div class="fragment"><pre class="fragment">apt-<span class="keyword">get</span> install g++ cmake libitpp-dev  
     79</pre></div><p> 
     80<dl class="note" compact><dt><b>Note:</b></dt><dd>If you want to use mex files, you need to build IT++ from sources using the classi configure;make;make install. The necessary flags for configure for mex compilation are in file linux/configure_itpp.</dd></dl> 
     81Compile the BDM library and its applications using <div class="fragment"><pre class="fragment">$ cd &lt;bdm_dir&gt;/library/ 
    9182$ cmake . 
    9283$ make 
    93 </pre></div><h2><a class="anchor" id="win"> 
     84</pre></div><h2><a class="anchor" name="win"> 
    9485Windows</a></h2> 
    95 <p>The following approach was tested on Visual Studio 9, so we recommend to download and install it. <a href="http://www.microsoft.com/express/vc/">http://www.microsoft.com/express/vc/</a></p> 
    96 <p>Make sure you have cmake installed.</p> 
    97 <p>Expert users are advised to download and compile their ITPP version following a guide on : <a href="http://itpp.sourceforge.net/current/installation.html">http://itpp.sourceforge.net/current/installation.html</a></p> 
    98 <p>For convenience of the beginners, DLLS of the ACML and lib+include files for ITPP and ACML are provided at: <a href="http://staff.utia.cas.cz/smidl/Public/mixpp_win32lib.zip">http://staff.utia.cas.cz/smidl/Public/mixpp_win32lib.zip</a> If you want to use them copy the content of the zip file to &lt;bdm_dir&gt;/library/system/win32/ directory and make sure to set your PATH environment variable: </p> 
    99 <div class="fragment"><pre class="fragment"> Path = %PATH%; &lt;bdm_dir&gt;\library\system\win32\dll 
    100 </pre></div><p> Otherwise you will not be able to run any programs.</p> 
    101 <p>Compilation of BDM:</p> 
    102 <p>When everything is set-up, make a copy of library\system\win32\run_cmake.bat, edit it to reflect your environment (i.e. change paths to cmake and your C++ target environment) and run it.</p> 
    103 <p>It should generate build files for your compiler in the main BDM directory</p> 
    104 <h2><a class="anchor" id="mac"> 
     86The following approach was tested on Visual Studio 9, so we recommend to download and install it. <a href="http://www.microsoft.com/express/vc/">http://www.microsoft.com/express/vc/</a><p> 
     87Make sure you have cmake installed.<p> 
     88Expert users are advised to download and compile their ITPP version following a guide on : <a href="http://itpp.sourceforge.net/current/installation.html">http://itpp.sourceforge.net/current/installation.html</a><p> 
     89For convenience of the beginners, DLLS of the ACML and lib+include files for ITPP and ACML are provided at: <a href="http://staff.utia.cas.cz/smidl/Public/mixpp_win32lib.zip">http://staff.utia.cas.cz/smidl/Public/mixpp_win32lib.zip</a> If you want to use them copy the content of the zip file to &lt;bdm_dir&gt;/library/system/win32/ directory and make sure to set your PATH environment variable: <div class="fragment"><pre class="fragment"> Path = %PATH%; &lt;bdm_dir&gt;\library\system\win32\dll 
     90</pre></div><p> 
     91Be sure to set system variable globally, i.e., through the dialog box "System Properties", tab "Advanced" and button "Environment Variables". Otherwise you will not be able to run any programs.<p> 
     92Compilation of BDM:<p> 
     93When everything is set-up, make a copy of library\system\win32\run_cmake.bat, edit it to reflect your environment (i.e. change paths to cmake and your C++ target environment) and run it.<p> 
     94It should generate build files for your compiler in the main BDM directory<h2><a class="anchor" name="mac"> 
    10595Mac OS X</a></h2> 
    106 <p>All prerequisities for Mac OS X are avaliable except for ITPP, make sure you have them installed.</p> 
    107 <p>However, its compilation is straightforward.</p> 
    108 <p>1. Download the latest stable release from <a href="http://itpp.sourceforge.net">http://itpp.sourceforge.net</a> 2. Compile it using script system/mac/itpp_compile.sh</p> 
    109 <p>The default cmake configuration is looking for itpp in directory mac/itpp, make sure you have symlinks to this directory.</p> 
    110 <p>If itpp compilation is successfull, you can run Cmake. Fill in the paths to your BDM directory, run Configure followed by Create. Configuration files for your favourite build environment should be created in the BDM directory. </p> 
    111 </div> 
    112 <hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 27 00:49:04 2009 for mixpp by&nbsp; 
     96All prerequisities for Mac OS X are avaliable except for ITPP, make sure you have them installed.<p> 
     97However, its compilation is straightforward.<p> 
     981. Download the latest stable release from <a href="http://itpp.sourceforge.net">http://itpp.sourceforge.net</a> 2. Compile it using script system/mac/itpp_compile.sh<p> 
     99The default cmake configuration is looking for itpp in directory mac/itpp, make sure you have symlinks to this directory.<p> 
     100If itpp compilation is successfull, you can run Cmake. Fill in the paths to your BDM directory, run Configure followed by Create. Configuration files for your favourite build environment should be created in the BDM directory. </div> 
     101<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:44 2009 for mixpp by&nbsp; 
    113102<a href="http://www.doxygen.org/index.html"> 
    114 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> 
     103<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> 
    115104</body> 
    116105</html>