/** \page page_installation Installation * * \section sec_installation_0_5 Before you start * * If you are only interested in using the library under Matlab, now there is a precompiled mex-library for 64-bit systems available. You can download it from: * \verbatim Windows: http://laurentkneip.github.io/publications/opengv.mexw64 Mac OSX: http://laurentkneip.github.io/publications/opengv.mexmaci64 \endverbatim * * These versions have been added around March 2016, so please be aware that later additions may not be included in this distribution. You can go immediately to \ref page_matlab "Use under Matlab" to receive further instructions on the Matlab interface. * * \section sec_installation_1 Downloading the source code * * OpenGV is freely available under * \verbatim https://github.com/laurentkneip/opengv \endverbatim * * You may first have to register on github.com. You can just download a zip-file with the code, but we strongly recommend that you make yourself familiar with git. Git is a distributed version-control and source code management system. By using git to clone the repository locally, you can easily get updates at a later stage, and also facilitate the integration of own improvements or extensions into the original repository on github. This is done using the pull-request mechanism. * * To clone the library under Mac OSX or Linux, simply type (assuming that git is installed): * \verbatim git clone https://github.com/laurentkneip/opengv \endverbatim * * Under Windows you probably have a similar option. More information about git can be found here: * \verbatim http://git-scm.com/ \endverbatim * * Follow the "Try git" link for an amazing interactive tutorial. * * \section sec_installation_2 Installation under Linux * * * * \section sec_installation_3 Installation under Windows * * * * \section sec_installation_35 Installation under OSX * * Has been succesfully tested as well. * * * * \section sec_installation_36 Installing OpenGV on the host OS * * Installation on the host OS (including the headers) can be activated by simply launching the install target. * By using "sudo make install" on Linux and OSX and by compiling the install target on the opengv Visual Studio solution in Windows. Sudo is required for system install. * You can choose to have a local installation path by setting the cmake variable CMAKE_INSTALL_PREFIX to the path of your choice by using -DCMAKE_INSTALL_PREFIX:STRING="YourInstallPath" in the cmake command line. \verbatim cmake ../opengv -DEIGEN_INCLUDE_DIR="EigenIncludePath" -DBUILD_TESTS=ON -DCMAKE_INSTALL_PREFIX="YourInstallPath" make make install #sudo not required since we use a local installation \endverbatim * * \section sec_installation_4 Installing the Matlab-wrapper (Windows-version) * * * * \section sec_installation_5 Installing the Matlab-wrapper (Linux-version) * * The following has been tested under Ubuntu 12.04 and a recent Matlab edition (>2013) (thanks to Oliver Dunkley for providing this information). * * * * \section sec_installation_6 Installing the Matlab-wrapper (OSX-version) * * To compile the Matlab interface under OSX, use the same command as under Windows, with adapted library folder (-L../build/lib instead of -L../build/lib/Release). You of course need to make sure again that Matlab knows where to find the library, and that a suitable compiler is set up in Matlab as well. * * \section sec_installation_7 Installing the python wrappers * * The Python wrappers depend on the pybind11 library, which is included as a git submodule. * To get it, run \verbatim git submodule update --init --recursive \endverbatim * With that done, the compliation of the Python wrappers can be enabled by setting the option BUILD_PYTHON to ON. * The especific version of Python to target can be set using the option PYBIND11_PYTHON_VERSION. * For example, \verbatim cmake ../opengv -DBUILD_PYTHON=ON -DPYBIND11_PYTHON_VERSION=3.6 \endverbatim * Note that the python wrappers currently only allow access to the central methods. * * \section sec_installation_8 Using the OpenGV inside your cmake c++ project * * Once your have a system or local install of opengv you can use it in your own project. * In your cmake file, add the search for the opengv library: \verbatim find_package(opengv REQUIRED) if (opengv_FOUND) add_executable(main_opengv_demo main.cpp) target_link_libraries(main_opengv_demo opengv) endif (opengv_FOUND) \endverbatim * * Then run cmake for your project (if you are using a local install of opengv, you can specify where the library is located by using -Dopengv_DIR: \verbatim cmake ../myproject -DCMAKE_BUILD_TYPE=RELEASE -Dopengv_DIR:STRING=/home/Foo/Documents/Dev/opengv_Build/install/CMake/ \endverbatim */