index.html 18.9 KB

Edit Raw Blame History

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">


        <link rel="shortcut icon" href="../docs/img/openbr.ico">


	<title>Install - OpenBR</title>

        <link href="../css/bootstrap-custom.min.css" rel="stylesheet">
        <link href="../css/font-awesome-4.0.3.css" rel="stylesheet">
        <link rel="stylesheet" href="../css/highlight.css">
        <link href="../css/base.css" rel="stylesheet">

        <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
        <!--[if lt IE 9]>
            <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
            <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
        <![endif]-->


    </head>

    <body data-spy="scroll" data-target="#bs-sidebar">

        <div class="navbar navbar-default navbar-fixed-top" role="navigation">
    <div class="container">

        <!-- Collapsed navigation -->
        <div class="navbar-header">
            <!-- Expander button -->
            <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
            </button>

            <!-- Main title -->
            <a class="navbar-brand" href="..">OpenBR</a>
        </div>

        <!-- Expanded navigation -->
        <div class="navbar-collapse collapse">
            <!-- Main navigation -->
            <ul class="nav navbar-nav">


                <li >
                    <a href="..">Home</a>
                </li>


                <li class="active">
                    <a href="./">Install</a>
                </li>


                <li >
                    <a href="../tutorials/">Tutorials</a>
                </li>


                <li >
                    <a href="../technical/">Technical Overviews</a>
                </li>


                <li class="dropdown">
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">More <b class="caret"></b></a>
                    <ul class="dropdown-menu">

                        <li >
                            <a href="../contribute/">Contribute</a>
                        </li>

                        <li >
                            <a href="../papers/">Publications</a>
                        </li>

                    </ul>
                </li>


                <li class="dropdown">
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">API Docs <b class="caret"></b></a>
                    <ul class="dropdown-menu">

                        <li >
                            <a href="../docs/c_api/">C API</a>
                        </li>

                        <li >
                            <a href="../docs/cpp_api/">C++ Plugin API</a>
                        </li>

                        <li >
                            <a href="../docs/cl_api/">Command Line API</a>
                        </li>

                    </ul>
                </li>


                <li class="dropdown">
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Plugin Docs <b class="caret"></b></a>
                    <ul class="dropdown-menu">

                        <li >
                            <a href="../docs/plugins/classification/">Classification</a>
                        </li>

                        <li >
                            <a href="../docs/plugins/cluster/">Cluster</a>
                        </li>

                        <li >
                            <a href="../docs/plugins/core/">Core</a>
                        </li>

                        <li >
                            <a href="../docs/plugins/distance/">Distance</a>
                        </li>

                        <li >
                            <a href="../docs/plugins/format/">Format</a>
                        </li>

                        <li >
                            <a href="../docs/plugins/gallery/">Gallery</a>
                        </li>

                        <li >
                            <a href="../docs/plugins/gui/">GUI</a>
                        </li>

                        <li >
                            <a href="../docs/plugins/imgproc/">Image Processing</a>
                        </li>

                        <li >
                            <a href="../docs/plugins/io/">I/O</a>
                        </li>

                        <li >
                            <a href="../docs/plugins/metadata/">Metadata</a>
                        </li>

                        <li >
                            <a href="../docs/plugins/output/">Output</a>
                        </li>

                        <li >
                            <a href="../docs/plugins/video/">Video</a>
                        </li>

                    </ul>
                </li>


            </ul>

            <!-- Search, Navigation and Repo links -->
            <ul class="nav navbar-nav navbar-right">

                <li >
                    <a rel="next" href="..">
                        <i class="fa fa-arrow-left"></i> Previous
                    </a>
                </li>
                <li >
                    <a rel="prev" href="../tutorials/">
                        Next <i class="fa fa-arrow-right"></i>
                    </a>
                </li>

                <li>
                    <a href="https://github.com/biometrics/openbr">

                            <i class="fa fa-github"></i>

                        GitHub
                    </a>
                </li>

            </ul>
        </div>
    </div>
</div>

        <div class="container">
            <div class="col-md-3"><div class="bs-sidebar hidden-print affix" role="complementary">
    <ul class="nav bs-sidenav">

        <li class="main active"><a href="#linux">Linux</a></li>


        <li class="main "><a href="#osx">OSX</a></li>


        <li class="main "><a href="#windows">Windows</a></li>


        <li class="main "><a href="#raspian">Raspian</a></li>


    </ul>
</div></div>
            <div class="col-md-9" role="main">

<p>A hacker's guide to building, editing, and running OpenBR.</p>
<hr />
<h1 id="linux">Linux</h1>
<ol>
<li>
<p>Install GCC 4.7.3</p>
<pre><code>$ sudo apt-get update
$ sudo apt-get install build-essential
</code></pre>
</li>
<li>
<p>Install CMake 2.8.10.1</p>
<pre><code>$ sudo apt-get install cmake cmake-curses-gui
</code></pre>
</li>
<li>
<p><a href="http://downloads.sourceforge.net/project/opencvlibrary/opencv-unix/2.4.5/opencv-2.4.5.tar.gz">Download OpenCV 2.4.5</a>, <strong>note</strong> <a href="https://github.com/biometrics/openbr/wiki/Build-OpenCV-with-Video-Support-on-Ubuntu">this</a></p>
<pre><code>$ cd ~/Downloads
$ tar -xf opencv-2.4.5.tar.gz
$ cd opencv-2.4.5
$ mkdir build
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ make -j4
$ sudo make install
$ cd ../..
$ rm -rf opencv-2.4.5*
</code></pre>
</li>
<li>
<p>Install Qt 5.0.1</p>
<pre><code>$ sudo apt-get install qt5-default libqt5svg5-dev qtcreator
</code></pre>
</li>
<li>
<p>Create a <a href="github.com">GitHub</a> account, follow their instructions for <a href="https://help.github.com/articles/set-up-git">setting up Git</a>.</p>
<pre><code>$ git clone https://github.com/biometrics/openbr.git
$ cd openbr
$ git checkout 0.5
$ git submodule init
$ git submodule update
</code></pre>
</li>
<li>
<p>Build OpenBR!</p>
<pre><code>$ mkdir build # from the OpenBR root directory
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ make -j4
$ sudo make install
</code></pre>
</li>
<li>
<p>Hack OpenBR!</p>
<ol>
<li>
<p>Open Qt Creator IDE</p>
<p>$ qtcreator &amp;</p>
</li>
<li>
<p>From the Qt Creator "File" menu select "Open File or Project...".</p>
</li>
<li>Select "openbr/CMakeLists.txt" then "Open".</li>
<li>Browse to your pre-existing build directory "openbr/build" then select "Next".</li>
<li>Select "Run CMake" then "Finish".</li>
<li>You're all set! You can find more information on Qt Creator <a href="http://qt-project.org/doc/qtcreator">here</a> if you need.</li>
</ol>
</li>
<li>
<p>(Optional) Test OpenBR!</p>
<pre><code>$ cd openbr/scripts
$ ./downloadDatasets.sh
$ cd ../build
$ make test
</code></pre>
</li>
<li>
<p>(Optional) Package OpenBR!</p>
<pre><code>$ cd openbr/build
$ sudo cpack -G TGZ
</code></pre>
</li>
<li>
<p>(Optional) Build OpenBR documentation!</p>
<pre><code>$ sudo apt-get install doxygen
$ cd openbr/build
$ cmake -DBR_BUILD_DOCUMENTATION=ON ..
$ make -j4
$ sudo apt-get install libgnome2-bin
$ gnome-open html/index.html
</code></pre>
</li>
</ol>
<hr />
<h1 id="osx">OSX</h1>
<ol>
<li>
<p>Download and install the latest "Xcode" and "Command Line Tools" from the <a href="https://developer.apple.com/downloads/index.action#">Apple Developer Downloads</a> page.</p>
<ol>
<li><a href="http://www.cmake.org/files/v2.8/cmake-2.8.11.2.tar.gz">Download CMake 2.8.11.2</a><pre><code>$ cd ~/Downloads
$ tar -xf cmake-2.8.11.2.tar.gz
$ cd cmake-2.8.11.2
$ ./configure
$ make -j4
$ sudo make install
$ cd ..
$ rm -rf cmake-2.8.11.2*
</code></pre>
</li>
</ol>
</li>
<li>
<p><a href="http://downloads.sourceforge.net/project/opencvlibrary/opencv-unix/2.4.6.1/opencv-2.4.6.1.tar.gz">Download OpenCV 2.4.6.1</a></p>
<pre><code>$ cd ~/Downloads
$ tar -xf opencv-2.4.6.1.tar.gz
$ cd opencv-2.4.6.1
$ mkdir build
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ make -j4
$ sudo make install
$ cd ../..
$ rm -rf opencv-2.4.6.1*
</code></pre>
</li>
<li>
<p><a href="http://download.qt-project.org/official_releases/qt/5.1/5.1.1/qt-mac-opensource-5.1.1-clang-offline.dmg">Download and install Qt 5.1.1</a></p>
</li>
<li>
<p>Create a <a href="github.com">GitHub</a> account, follow their instructions for <a href="https://help.github.com/articles/set-up-git">setting up Git</a>.</p>
<pre><code>$ git clone https://github.com/biometrics/openbr.git
$ cd openbr
$ git checkout 0.5
$ git submodule init
$ git submodule update
</code></pre>
</li>
<li>
<p>Build OpenBR!</p>
<pre><code>$ mkdir build # from the OpenBR root directory
$ cd build
$ cmake -DCMAKE_PREFIX_PATH=~/Qt5.1.1/5.1.1/clang_64 -DCMAKE_BUILD_TYPE=Release ..
$ make -j4
$ sudo make install
</code></pre>
</li>
<li>
<p>Hack OpenBR!</p>
<ol>
<li>
<p>Open Qt Creator IDE</p>
<pre><code>$ open ~/Qt5.1.1/Qt\ Creator.app
</code></pre>
</li>
<li>
<p>From the Qt Creator "File" menu select "Open File or Project...".</p>
</li>
<li>Select "openbr/CMakeLists.txt" then "Open".</li>
<li>Browse to your pre-existing build directory "openbr/build" then select "Continue".</li>
<li>Select "Run CMake" then "Done".</li>
<li>You're all set! You can find more information on Qt Creator <a href="http://qt-project.org/doc/qtcreator">here</a> if you need.</li>
</ol>
</li>
<li>
<p>(Optional) Test OpenBR!</p>
<pre><code>$ cd openbr/scripts
$ ./downloadDatasets.sh
$ cd ../build
$ make test
</code></pre>
</li>
<li>
<p>(Optional) Package OpenBR!</p>
<pre><code>$ cd openbr/build
$ sudo cpack -G TGZ
</code></pre>
</li>
<li>
<p>(Optional) Build OpenBR documentation!</p>
<ol>
<li>
<p><a href="ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.5.src.tar.gz">Download Doxygen 1.8.5</a></p>
<pre><code>$ cd ~/Downloads
$ tar -xf doxygen-1.8.5.src.tar.gz
$ cd doxygen-1.8.5
$ ./configure
$ make -j4
$ sudo make install
$ cd ..
$ rm -rf doxygen-1.8.5*
</code></pre>
</li>
<li>
<p>Modify build settings and recompile.</p>
<pre><code>$ cd openbr/build
$ cmake -DBR_BUILD_DOCUMENTATION=ON ..
$ make -j4
$ open html/index.html
</code></pre>
</li>
</ol>
</li>
</ol>
<hr />
<h1 id="windows">Windows</h1>
<ol>
<li>
<p><a href="http://www.microsoft.com/en-us/download/details.aspx?id=34673">Download Visual Studio 2012 Express Edition for Windows Desktop</a> and install.</p>
<ol>
<li>Consider the free open source program <a href="http://wincdemu.sysprogs.org">WinCDEmu</a> if you need a program to mount ISO images.</li>
<li>You will have to register with Microsoft after installation, but it's free.</li>
<li>Grab any available <a href="http://www.microsoft.com/visualstudio/eng/downloads#d-visual-studio-2012-update">Visual Studio Updates</a>.</li>
<li>Download and install <a href="http://msdn.microsoft.com/en-us/windows/hardware/hh852363.aspx">Windows 8 SDK</a>.</li>
</ol>
</li>
<li>
<p><a href="http://www.cmake.org/files/v2.8/cmake-2.8.11.2-win32-x86.exe">Download and Install CMake 2.8.11.2</a></p>
<ol>
<li>During installation setup select "add CMake to PATH".</li>
</ol>
</li>
<li>
<p><a href="http://downloads.sourceforge.net/project/opencvlibrary/opencv-unix/2.4.6.1/opencv-2.4.6.1.tar.gz">Download OpenCV 2.4.6.1</a></p>
<ol>
<li>Consider the free open source program <a href="http://www.7-zip.org/">7-Zip</a> if you need a program to unarchive tarballs.</li>
<li>Move the "opencv-2.4.6.1" folder to "C:\".</li>
<li>Open "VS2012 x64 Cross Tools Command Prompt" (from the Start Menu, select "All Programs" -&gt; "Microsoft Visual Studio 2012" -&gt; "Visual Studio Tools" -&gt; "VS2012 x64 Cross Tools Command Prompt") and enter:<pre><code>$ cd C:\opencv-2.4.6.1
$ mkdir build-msvc2012
$ cd build-msvc2012
$ cmake -G "NMake Makefiles" -DBUILD_PERF_TESTS=OFF -DBUILD_TESTS=OFF -DWITH_FFMPEG=OFF -DCMAKE_BUILD_TYPE=Debug ..
$ nmake
$ nmake install
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ nmake
$ nmake install
$ nmake clean
</code></pre>
</li>
</ol>
</li>
<li>
<p><a href="http://download.qt-project.org/official_releases/qt/5.1/5.1.1/qt-windows-opensource-5.1.1-msvc2012-x86_64-offline.exe">Download and Install Qt 5.1.1</a></p>
</li>
<li>
<p>Create a <a href="github.com">GitHub</a> account and follow their instructions for <a href="https://help.github.com/articles/set-up-git">setting up Git</a>.</p>
<ol>
<li>Launch "Git Bash" from the Desktop and clone OpenBR:<pre><code>$ cd /c
$ git clone https://github.com/biometrics/openbr.git
$ cd openbr
$ git checkout 0.5
$ git submodule init
$ git submodule update
</code></pre>
</li>
</ol>
</li>
<li>
<p>Build OpenBR!</p>
<ol>
<li>
<p>From the VS2012 x64 Cross Tools Command Prompt:</p>
<pre><code>$ cd C:\openbr
$ mkdir build-msvc2012
$ cd build-msvc2012
$ cmake -G "CodeBlocks - NMake Makefiles" -DCMAKE_PREFIX_PATH="C:/opencv-2.4.6.1/build-msvc2012/install;C:/Qt/Qt5.1.1/5.1.1/msvc2012_64" -DCMAKE_INSTALL_PREFIX="./install" -DBR_INSTALL_DEPENDENCIES=ON -DCMAKE_BUILD_TYPE=Release ..
$ nmake
$ nmake install
</code></pre>
</li>
<li>
<p>Check out the "install" folder.</p>
</li>
</ol>
</li>
<li>
<p>Hack OpenBR!</p>
<ol>
<li>From the VS2012 x64 Cross Tools Command Prompt:
    $ C:\Qt\Qt5.1.1\Tools\QtCreator\bin\qtcreator.exe</li>
<li>From the Qt Creator "Tools" menu select "Options..."</li>
<li>Under "Kits" select "Desktop (default)"</li>
<li>For "Compiler:" select "Microsoft Visual C++ Compiler 11.0 (x86_amd64)" and click "OK"</li>
<li>From the Qt Creator "File" menu select "Open File or Project...".</li>
<li>Select "C:\openbr\CMakeLists.txt" then "Open".</li>
<li>If prompted for the location of CMake, enter "C:\Program Files (x86)\CMake 2.8\bin\cmake.exe".</li>
<li>Browse to your pre-existing build directory "C:\openbr\build-msvc2012" then select "Next".</li>
<li>Select "Run CMake" then "Finish".</li>
<li>You're all set! You can find more information on Qt Creator <a href="http://qt-project.org/doc/qtcreator">here</a> if you need.</li>
</ol>
</li>
<li>
<p>(Optional) Package OpenBR!</p>
<ol>
<li>From the VS2012 x64 Cross Tools Command Prompt:
    $ cd C:\openbr\build-msvc2012
    $ cpack -G ZIP</li>
</ol>
</li>
</ol>
<hr />
<h1 id="raspian">Raspian</h1>
<ol>
<li>
<p>Install CMake 2.8.9</p>
<pre><code>$ sudo apt-get install cmake
</code></pre>
</li>
<li>
<p>Download OpenCV 2.4.9</p>
<pre><code>$ wget http://sourceforge.net/projects/opencvlibrary/files/opencv-unix/2.4.9/opencv-2.4.9.zip
$ unzip opencv-2.4.9.zip
$ cd opencv-2.4.9
$ mkdir build
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ make
$ sudo make install
$ cd ../..
$ rm -rf opencv-2.4.9*
</code></pre>
</li>
<li>
<p>Install Qt5</p>
<ol>
<li>
<p>Modify source list</p>
<pre><code>$ nano /etc/apt/sources.list
</code></pre>
<p>by changing:</p>
<pre><code>$ deb http://mirrordirector.raspbian.org/raspbian/ wheezy main contrib non-free rpi
</code></pre>
<p>to:</p>
<pre><code>$ deb http://mirrordirector.raspbian.org/raspbian/ jessie main contrib non-free rpi
</code></pre>
</li>
</ol>
</li>
<li>
<p>Update apt-get</p>
<pre><code>$ sudo apt-get update
</code></pre>
</li>
<li>
<p>Install packages</p>
<pre><code>$ sudo apt-get install qt5-default libqt5svg5-dev
</code></pre>
</li>
<li>
<p>Create a <a href="github.com">GitHub</a> account, follow their instructions for <a href="https://help.github.com/articles/set-up-git">setting up Git</a>.</p>
<pre><code>$ git clone https://github.com/biometrics/openbr.git
$ cd openbr
$ git checkout 0.5
$ git submodule init
$ git submodule update
</code></pre>
</li>
<li>
<p>Build OpenBR!</p>
<pre><code>$ mkdir build # from the OpenBR root directory
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ make
$ sudo make install
</code></pre>
</li>
<li>
<p>(Optional) Test OpenBR!</p>
<pre><code>$ cd openbr/scripts
$ ./downloadDatasets.sh
$ cd ../build
$ make test
</code></pre>
</li>
</ol></div>
        </div>

        <!-- Search modal.  Not yet supported. -->
<div class="modal fade" id="searchModal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
        <h4 class="modal-title" id="searchModalLabel">Documentation search</h4>
      </div>
      <div class="modal-body">
        ...
      </div>
      <div class="modal-footer">
        <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
      </div>
    </div>
  </div>
</div>

        <script src="../js/jquery-1.10.2.min.js"></script>
        <script src="../js/bootstrap-3.0.3.min.js"></script>
        <script src="../js/highlight.pack.js"></script>
        <script src="../js/base.js"></script>
    </body>
</html>