Commit 322f0744 authored by Cédric Traizet's avatar Cédric Traizet

Merge branch 'doc_sb_version' into 'develop'

Update the  CompilingOTBFromSource Cookbook section

See merge request orfeotoolbox/otb!611
parents dc9f0c88 2aec5d5c
......@@ -23,61 +23,60 @@ majority) are optional and can be activated or not during the build
process:
.. table:: External libraries used in OTB
:align: center
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| **Library** | **Mandatory** | **Minimum version** | **Superbuild Version** |
+==================================================================+=======================+==========================+==========================+
| `ITK <http://www.itk.org>`_ | Yes | 4.6.0 | 4.13 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `GDAL <http://www.gdal.org>`_ | Yes | 2.0 | 2.4.1 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `OSSIM <http://www.ossim.org>`_ | Yes | 1.8.20-3 | 1.8.20 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `libgeotiff <http://trac.osgeo.org/geotiff/>`_ | Yes | | 1.4.2 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `boost <http://www.boost.org>`_ | Yes | | 1.60 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `openthreads <http://www.openscenegraph.org>`_ | Yes | | 3.4.0 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `tinyXML <http://www.grinninglizard.com/tinyxml>`_ | Yes | | 2.6.2 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `6S <http://6s.ltdri.org>`_ | No | | |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `Curl <http://www.curl.haxx.se>`_ | No | | 7.54.1 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `FFTW <http://www.fftw.org>`_ | No | | 3.3.8 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `GLEW <http://glew.sourceforge.net/>`_ | No | | 1.13 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `GLFW <http://www.glfw.org/>`_ | No | 3 | 3.1.2 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `GLUT <https://www.opengl.org/resources/libraries/glut/>`_ | No | | 2.8.1 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `libKML <https://github.com/google/libkml>`_ | No | 1.2 | 1.3.0 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `libSVM <http://www.csie.ntu.edu.tw/~cjlin/libsvm>`_ | No | 2.0 | 3.22 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `MPI <https://www.open-mpi.org/>`_ | No | | |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `MuParser <http://www.muparser.sourceforge.net>`_ | No | | 2.2.5 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `MuParserX <http://muparserx.beltoforion.de>`_ | No | 4.0.7 | 4.0.7 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `OpenCV <http://opencv.org>`_ | No | 2 (3.x also supported) | 3.4.1 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `OPENGL <https://www.opengl.org/>`_ | No | | |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `Qt <https://www.qt.io/developers/>`_ | No | 5 | 5.10.1 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `QWT <http://qwt.sourceforge.net>`_ | No | 6 | 6.1.3 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `Shark <http://image.diku.dk/shark/>`_ | No | 4 | 4.0 |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `SiftFast <http://libsift.sourceforge.net>`_ | No | | |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
| `SPTW <https://github.com/remicres/sptw.git>`_ | No | | |
+------------------------------------------------------------------+-----------------------+--------------------------+--------------------------+
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| **Library** | **Mandatory** | **Minimum version** | **Superbuild Version** |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `ITK <http://www.itk.org>`_ | Yes | 4.6.0 | 4.13.1 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `GDAL <http://www.gdal.org>`_ | Yes | 2.0 | 2.4.1 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `OSSIM <http://www.ossim.org>`_ | Yes | 1.8.20-3 | 1.8.20 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `libgeotiff <http://trac.osgeo.org/geotiff/>`_ | Yes | | 1.4.2 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `boost <http://www.boost.org>`_ | Yes | | 1.69 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `openthreads <http://www.openscenegraph.org>`_ | Yes | | 3.4.0 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `tinyXML <http://www.grinninglizard.com/tinyxml>`_ | Yes | | 2.6.2 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `6S <http://6s.ltdri.org>`_ | No | | |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `Curl <http://www.curl.haxx.se>`_ | No | | 7.54.1 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `FFTW <http://www.fftw.org>`_ | No | | 3.3.8 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `GLEW <http://glew.sourceforge.net/>`_ | No | | 1.13 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `GLFW <http://www.glfw.org/>`_ | No | 3 | 3.1.2 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `GLUT <https://www.opengl.org/resources/libraries/glut/>`_ | No | | 2.8.1 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `libKML <https://github.com/google/libkml>`_ | No | 1.2 | 1.3.0 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `libSVM <http://www.csie.ntu.edu.tw/~cjlin/libsvm>`_ | No | 2.0 | 3.22 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `MPI <https://www.open-mpi.org/>`_ | No | | |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `MuParser <http://www.muparser.sourceforge.net>`_ | No | | 2.2.5 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `MuParserX <http://muparserx.beltoforion.de>`_ | No | 4.0.7 | 4.0.7 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `OpenCV <http://opencv.org>`_ | No | 2 (3.x and 4.x supported) | 4.1.1 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `OPENGL <https://www.opengl.org/>`_ | No | | |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `Qt <https://www.qt.io/developers/>`_ | No | 5 | 5.10.1 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `QWT <http://qwt.sourceforge.net>`_ | No | 6 | 6.1.3 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `Shark <http://image.diku.dk/shark/>`_ | No | 4 | 4.0 |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `SiftFast <http://libsift.sourceforge.net>`_ | No | | |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
| `SPTW <https://github.com/remicres/sptw.git>`_ | No | | |
+------------------------------------------------------------------+-----------------------+----------------------------+--------------------------+
GNU/Linux and macOS
-------------------
......@@ -320,7 +319,7 @@ installation location:
+---------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **CMake variable** | **3rd party module** | **Modules depending on it** |
+===========================+========================+===========================================================================================================================================================================+
+---------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **OTB\_USE\_LIBKML** | OTBlibkml | OTBKMZWriter OTBIOKML OTBAppKMZ |
+---------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **OTB\_USE\_QT** | OTBQt | OTBQtWidget |
......@@ -373,11 +372,16 @@ hours to run them all, depending on compilation options
To run the tests, first make sure to set the option
``BUILD_TESTING`` to ``ON`` before building the library.
For some of the tests, you also need the test data and the baselines (~1GB):
For some of the tests, you also need the test data and the baselines (~1GB). These files are stored
using `git-lfs` in the `Data` folder at the root of otb sources. To download them, you have to make
sure `git-lfs` is installed before cloning otb (binaries for `git lfs` are available for different
OS `here <https://github.com/git-lfs/git-lfs/releases>`_).
After downloading, add the binary to $PATH and run `git lfs install`. You can then clone otb sources :
::
git clone https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb-data.git
git clone https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb.git
Once OTB is built with the tests, you just have to go to the binary
directory where you built OTB and run ``ctest -N`` to have a list of all
......@@ -395,9 +399,6 @@ To build the CookBook documentation, the following python packages are required:
pip install numpy sphinx sphinx_rtd_theme
A working installation of ``latex`` is
required for building the PDF version.
Enable Python bindings and set ``BUILD_COOKBOOK``:
::
......@@ -410,10 +411,5 @@ Then, build the target:
make CookbookHTML
::
make CookBookPDF
.. _devtoolset6: https://www.softwarecollections.org/en/scls/rhscl/devtoolset-6/
.. _devtoolset7: https://www.softwarecollections.org/en/scls/rhscl/devtoolset-7/
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment