TerraLib and TerraView Wiki Page

You are here: start » wiki » documentation » devguide » build

Differences

This shows you the differences between two versions of the page.

--- wiki:documentation:devguide:build [2018/01/24 14:47]
marisa
+++ wiki:documentation:devguide:build [2024/12/04 17:22] (current)
castejon [Building Plugin TerraPrint with Visual C++ 2017]
@@ Line 2: / Line 2: @@
 Make sure you have all the third-party library dependencies listed in the section **[[[[:wiki:documentation:devguide:dependencies|Dependencies]]** before trying to build TerraLib/TerraView.
-After **[[:wiki:documentation:devguide:cloning|cloning the TerraLib repository]]**, choose the right **[[:wiki:documentation:devguide:branches_and_tags|branch or tag]]** to work on.
 The //**build/cmake**// folder (under the source tree) contains a CMake project for building TerraLib.
-Until now, TerraLib build has been tested on:
+TerraLib 5.5 build has been tested on:
-  * Linux Ubuntu 14.04 and 16.04
+  * Linux Ubuntu 18.04
-  * Mac OS X Yosemite, El Capitan and Sierra
+  * Mac OS X Sierra
-  * Microsoft Windows 7 and Windows 10
+  * Microsoft Windows 10
-You should use at least CMake version 2.8.12 for building TerraLib. Older versions than this may not work properly.
+You should use at least CMake version 3.18.1 for building TerraLib. Older versions than this may not work properly.
 Follow the build steps below according to your platform.
-===== Building on Microsoft Windows with Microsoft Visual C++ 2013 =====
+===== Building on Microsoft Windows with Microsoft Visual C++ 2017 =====
-**1.** Microsoft Visual Studio 2013 C++ users can download and unpack the suitable third-party libraries compiled for building 64-bit version of TerraLib with Qt5.4.1 support. Choose the right version specified by ''x.y.z'' at terralib-x.y.z-3rdparty-msvc-2013-win64:
+**1.** Microsoft Visual Studio 2017 C++ users can download and unpack the suitable third-party libraries compiled for building 64-bit version of TerraLib with Qt5.12.3 support. Choose the right version specified by ''x.y.z'' at terralib-x.y.z-3rdparty-msvc-2017-win64:
   *[[http://www.dpi.inpe.br/terralib5/terralib5-3rdparty/|Choose the right version specified by x.y.z]]
-  * Note that the same terralib5-3rdparty are used to build [[http://www.dpi.inpe.br/terralib5/terralib5-3rdparty/terralib-5.2.2-and-5.2.3-3rdparty-msvc-2013-win64.zip| 5.2.2 and 5.2.3]]
-  * Note that the same terralib5-3rdparty are used to build more than one version [[http://www.dpi.inpe.br/terralib5/terralib5-3rdparty/terralib-5.1.z-3rdparty-msvc-2013-win64.zip| 5.1.2,5.1.3,5.1.4 and 5.1.5]]
-Alternatively, download the most updated third-party library used by developers at [[http://www.dpi.inpe.br/terralib5-devel/3rdparty/bin/| binary package with all the dependencies]]
+Alternatively, download the most updated third-party library used by developers working at DEVELOP branch [[http://www.dpi.inpe.br/terralib5-devel/3rdparty/bin|here]].
+To work in RELEASE-5.Y branches go to the 5.Y corresponding directory to access the right third party used.
-**2.** Uncompress the above package into a folder:
+**2.** Uncompress the third-party package into a folder:
 <code>
 c:\terralib5\3rdparty
@@ Line 50: / Line 48: @@
   * Click in "Add entry":
-    * Add new variable named **CMAKE_PREFIX_PATH**, select type as **PATH** and fill value with the dependencies path: ''c:\terralib5\3rdparty''.
+    * Add new variable named **CMAKE_PREFIX_PATH**((as a example c:\terralib5\3rdparty;c:\terralib5\3rdparty/lib/cmake/terralib-4.2.2;C:\Qt\5.12.3\msvc2017_64\lib\cmake\Qt5;c:\terralib5\3rdparty\lib\cmake\wtss_cxx-0.4.0;c:\Python366)), select type as **PATH** and fill its value with the following dependencies paths separated by semicolon (;)
-  * At the same **CMAKE_PREFIX_PATH** variable, add the following locations separeted by ";":
+^Dependencies^PATH^
-    * Qt5 path: ''c:\<Qt5 path>\lib\cmake'' (or something similar)((This is the folder where the dir **Qt5** containing the **Qt5Config.cmake** file can be find)).
+|third-party| ''c:\terralib5\3rdparty''|
-    * Terralib4 path: ''c:\terralib5\3rdparty\lib\cmake\terralib-4.2.2''
+|Qt         | ''c:\<Qt5 path>\lib\cmake'' (or something similar)((This is the folder where the dir **Qt5** containing the **Qt5Config.cmake** file can be find))|
-    * Swig path: ''c:\terralib5\3rdparty\swig''
+|Terralib4 | ''c:\terralib5\3rdparty\lib\cmake\terralib-4.2.2''|
+|swig | ''c:\terralib5\3rdparty\swig''|
+|Python    | ''c:\Python366''|
   * Click in "Configure" button.
+    * Select option "Visual Studio 15 2017 Win64"
+    * If the output folder (c:\terralib5\build) does not exist, CMake GUI will prompt you for creating it: just confirm the creation.
-  * Select option "Visual Studio 12 2013 Win64"
+  * if no problem occurs, set the following variables:
-  * If the output folder does not exist, CMake GUI will prompt you for creating it: just confirm the creation.
+^Entry^Variable^Value^
+|CPACK| CPACK_BINARY_NSYS| ON ((package generator (used in release)-disable the others))|
-  * if no problem occurs, set the following variables:
+|TERRALIB| TERRALIB_BUILD_AS_BUNDLE| ON|
-    * CPACK => See the CPACK entries and keep ON just the NSIS package generator (used in release). All other kind of packages must be disabled.
+|TERRALIB| TERRALIB_BUILD_AS_DEV| ON|
-    * TERRALIB_BUILD_AS_BUNDLE => ON
+|TERRALIB| TERRALIB_TRACK_3RDPARTY_DEPENDENCIES| ON|
-    * TERRALIB_BUILD_AS_DEV => ON
+|TERRALIB| TERRALIB_QHELP_ENABLED| ON|
-    * TERRALIB_TRACK_3RDPARTY_DEPENDENCIES => ON
+|TERRALIB| TERRALIB_QTRANSLATION_ENABLED| ON|
-    * TERRALIB_QHELP_ENABLED => ON
+|TERRALIB| TERRALIB_MOD_VM_ENABLED| ON ((it enable TERRALIB_MOD_VM_PYTHON_ENABLED,TERRALIB_MOD_VM_LUA_ENABLED))|
   * Some projects may be disabled through the following variables:
-    * TERRALIB_DOXYGEN_ENABLED => OFF  => if you want to distribute the API documentation this should be turn to on. But keep in mind that this option may take a considerable time, so you should do this only for final tests.
-    * TERRALIB_BUILD_EXAMPLES_ENABLED => OFF
-    * TERRALIB_BUILD_EXAMPLES_ENABLED => OFF
-  * Press ''Configure'' and ''Generate'' again.
-  * Click in "Generate": this will generate a solution file for Visual Studio 2013 under the folder ''c:\terralib5\build'' ((The location set in "Where to build the binaries")).
-**5.** Open the solution file located at:
+|TERRALIB| TERRALIB_DOXYGEN_ENABLED | OFF((if you want to distribute the API documentation this should be turn to on. But keep in mind that this option may take a considerable time, so you should do this only for final releases))|
-<code>
+|TERRALIB| TERRALIB_BUILD_EXAMPLES_ENABLED | OFF|
-c:\terralib5\build\terralib.sln
+|TERRALIB| TERRALIB_BUILD_UNITTEST_ENABLED | OFF|
-</code>
-**6.** Build ALL_BUILD ((Inside Visual Studio, right click over the project ALL_BUILD and build)), and before running, set the local environment of terraview project ((terraview->Properties->Configuration Properties-> Debugging, set the Environment entry as ''PATH=c:\terralib5\3rdparty\lib;c:\<Qt5 path>\bin'')).
+  * Press ''Configure'' again.
+  * Some entries might not be filled automatically by cmake, so do it manually. Examples of entries not filled are:
-**7.** If TERRALIB_BUILD_EXAMPLES_ENABLED => ON or TERRALIB_BUILD_EXAMPLES_ENABLED => ON: to run and debug one of the terralib_example_* or terralib_unitest_*, set it as ''StartUp'' Project and make sure the data ([[http://www.dpi.inpe.br/terralib5-devel/data.zip| data.zip]]) used by these examples/unittest are uncompressed at the default directory specified by TERRALIB_DATA_DIR :
+|Boost| Boost_PYTHON_LIBRARY_RELEASE |''c:\terralib5\3rdparty\lib/boost_python3-mt.lib''|
+|Boost| Boost_PYTHON_LIBRARY_DEBUG |''c:\terralib5\3rdparty\lib/boost_python3-mt-gd.lib''|
+|Qscintilla| Qscintilla_LIBRARY_RELEASE |''c:\terralib5\3rdparty\lib/qscintilla2.lib''|
+  * Press ''Configure'' again.
+  * Press ''Generate'': this will generate a solution file for Visual Studio 2017 under the folder ''c:\terralib5\build\terralib.sln'' ((The location set in "Where to build the binaries")).
+  * Press ''Open Project'' to open Visual Studio 2017
+**5.** Inside Visual Studio choose "Release" as "Solution config" and select "x64" as platform. Right click over the project ALL_BUILD and build. Before running, set it as ''StartUp'' Project and set the local environment of terraview project ((terraview->Properties->Configuration Properties-> Debugging, set the Environment entry as ''PATH=c:\terralib5\3rdparty\lib;c:\<Qt5 path>\bin'')).
+**6.** If TERRALIB_BUILD_EXAMPLES_ENABLED => ON or TERRALIB_BUILD_EXAMPLES_ENABLED => ON: to run and debug one of the terralib_example_* or terralib_unitest_*, set it as ''StartUp'' Project and make sure the data ([[http://www.dpi.inpe.br/terralib5-devel/data/data.zip| data.zip]]) used by these examples/unittest are uncompressed at the default directory specified by TERRALIB_DATA_DIR :
    TERRALIB_DATA_DIR   C:\terralib\build-win64\data
+===== Adding Plugin TerraPrint as part of TerraView/TerraLib =====
-===== Building on Linux Ubuntu 14.04 and 16.04 with GNU G++ =====
+===== Building on Linux Ubuntu =====
 **1.** Open a Command Prompt (Shell).
@@ Line 100: / Line 108: @@
 **3.** Create a folder out of the TerraLib source tree to generate the build system, for example:
 <code bash>
-$ cd /home/user/mydevel/terralib
+$> cd /home/user/mydevel/terralib
-$ mkdir build-release
+$> mkdir build-release
-$ cd build-release
+$> cd build-release
 </code>
-**Note:** for the sake of simplicity create this directory in the same level as the source tree (as showned above).
+**Note:** for the sake of simplicity create this directory in the same level as the source tree (as shown above).
 **4.** For Linux systems you must choose the build configuration:
 <code bash>
-$ cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE:STRING="Release" -DCMAKE_INSTALL_PREFIX:PATH="/home/user/myinstall/terralib" -DCMAKE_PREFIX_PATH:PATH="/home/user/mylibs" ../codebase/build/cmake
+$> cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE:STRING="Release" -DCMAKE_INSTALL_PREFIX:PATH="/home/user/myinstall/terralib" -DCMAKE_PREFIX_PATH:PATH="/home/user/mylibs" ../codebase/build/cmake
+:: or inform some paths before as bellow:
+$> QT5_BASE_DIR="/home/user/Qt/" PATH=/home/user/Qt/5.12.3/gcc_64/bin/:$PATH cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE:STRING="Release" -DCMAKE_INSTALL_PREFIX:PATH="/home/user/myinstall/terralib" -DCMAKE_PREFIX_PATH:PATH="/home/user/mylibs" ../codebase/build/cmake
 </code>
 **5.** Building (with 4 process in parallel):
 <code bash>
-$ make -j 4
+$> make -j 4
+:: or inform some paths before as bellow:
+$> QT5_BASE_DIR="/home/user/Qt/" PATH=/home/user/Qt/5.12.3/gcc_64/bin/:$PATH make
 </code>
 **6.** Installing:
 <code bash>
-$ make install
+$> make install
 </code>
 **7.** Uninstalling:
 <code bash>
-$ make uninstall
+$> make uninstall
 </code>
@@ Line 161: / Line 173: @@
 </code>
-===== Building on Mac OS X El Capitan and Sierra =====
+===== Building on Mac OS X  Sierra =====
 **1.** Open a Command Prompt (Shell).
@@ Line 181: / Line 193: @@
 **4.** For Mac OS X systems you must choose the build configuration:
 <code>
-$ cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE:STRING="Release" -DCMAKE_INSTALL_PREFIX:PATH="/Users/user/myinstall/terralib" -DCMAKE_PREFIX_PATH:PATH="/Users/user/mylibs;/Users/user/mylibs/terralib5/lib/cmake;/Users/user/Qt5.4.1/5.4/clang_64/lib/cmake" ../codebase/build/cmake
+$ cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE:STRING="Release" -DCMAKE_INSTALL_PREFIX:PATH="/Users/user/myinstall/terralib" -DCMAKE_PREFIX_PATH:PATH="/Users/user/mylibs;/Users/user/mylibs/terralib5/lib/cmake;/Users/user/Qt5.12.3/lib/cmake" ../codebase/build/cmake
 </code>
@@ Line 202: / Line 214: @@
 **Notes:**
-  * You have to specify valid paths for **CMAKE_PREFIX_PATH**. If you have a Qt version installed as a framework in your home directory, you have to tell CMake where to locate its CMake support. For instance, if you have Qt version 5.4.1 installed, you have to add to **CMAKE_PREFIX_PATH** the following directory:
+  * You have to specify valid paths for **CMAKE_PREFIX_PATH**. If you have a Qt version installed as a framework in your home directory, you have to tell CMake where to locate its CMake support. For instance, if you have Qt version 5.12.3 installed, you have to add to **CMAKE_PREFIX_PATH** the following directory:
 <code>
-/Users/user/Qt5.4.1/5.4/clang_64/lib/cmake
+/Users/user/Qt5.12.3/lib/cmake
 </code>
@@ Line 217: / Line 229: @@
 DYLD_FALLBACK_FRAMEWORK_PATH
 </code>
+===== Building on Microsoft Windows with Microsoft Visual C++ 2013 (not supported anymore)=====
+**1.** Microsoft Visual Studio 2013 C++ users can download and unpack the suitable third-party libraries compiled for building 64-bit version of TerraLib with Qt5.12.3 support. Choose the right version specified by ''x.y.z'' at terralib-x.y.z-3rdparty-msvc-2013-win64:
+  *[[http://www.dpi.inpe.br/terralib5/terralib5-3rdparty/|Choose the right version specified by x.y.z]]
+  * Note that the same terralib5-3rdparty are used to build [[http://www.dpi.inpe.br/terralib5/terralib5-3rdparty/terralib-5.3.2-and-5.3.1-and-5.3.0-3rdparty-msvc-2013-win64.zip| 5.3.2, 5.3.1 and 5.3.0]]
+  * Note that the same terralib5-3rdparty are used to build [[http://www.dpi.inpe.br/terralib5/terralib5-3rdparty/terralib-5.2.2-and-5.2.3-3rdparty-msvc-2013-win64.zip| 5.2.2 and 5.2.3]]
+  * Note that the same terralib5-3rdparty are used to build more than one version [[http://www.dpi.inpe.br/terralib5/terralib5-3rdparty/terralib-5.1.z-3rdparty-msvc-2013-win64.zip| 5.1.2,5.1.3,5.1.4 and 5.1.5]]
+Alternatively, download the most updated third-party library used by developers at [[http://www.dpi.inpe.br/terralib5-devel/3rdparty/bin/| binary package with all the dependencies]]
+**2.** Uncompress the above package into a folder:
+<code>
+c:\terralib5\3rdparty
+</code>
+**3.** We will assume that the codebase ([[http://www.dpi.inpe.br/terralib5/wiki/doku.php?id=wiki:documentation:devguide:cloning |all the source tree ]]) is located at:
+<code>
+c:\terralib5\codebase
+</code>
+**4.** Open the CMake GUI:
+  * Set the "Where is the source code" edit text to:
+<code>
+c:\terralib5\codebase\build\cmake
+</code>
+  * Set the "Where to build the binaries" edit text to:
+<code>
+c:\terralib5\build
+</code>
+  * Mark the "Grouped" and "Advanced" check box.
+  * Click in "Add entry":
+    * Add new variable named **CMAKE_PREFIX_PATH**, select type as **PATH** and fill value with the dependencies path: ''c:\terralib5\3rdparty''.
+  * At the same **CMAKE_PREFIX_PATH** variable, add the following locations separeted by ";":
+    * Qt5 path: ''c:\<Qt5 path>\lib\cmake'' (or something similar)((This is the folder where the dir **Qt5** containing the **Qt5Config.cmake** file can be find)).
+    * Terralib4 path: ''c:\terralib5\3rdparty\lib\cmake\terralib-4.2.2''
+    * Swig path: ''c:\terralib5\3rdparty\swig''
+  * Click in "Configure" button.
+    * Select option "Visual Studio 12 2013 Win64"
+    * If the output folder does not exist, CMake GUI will prompt you for creating it: just confirm the creation.
+  * if no problem occurs, set the following variables:
+    * CPACK => See the CPACK entries and keep ON onlythe NSIS package generator (used in release). All other kind of packages must be disabled.
+    * TERRALIB entry => See the TERRALIB entries and set
+      * TERRALIB_BUILD_AS_BUNDLE => ON
+      * TERRALIB_BUILD_AS_DEV => ON
+      * TERRALIB_TRACK_3RDPARTY_DEPENDENCIES => ON
+      * TERRALIB_QHELP_ENABLED => ON
+    *  Some projects may be disabled through the following variables:
+    * TERRALIB_DOXYGEN_ENABLED => OFF  => if you want to distribute the API documentation this should be turn to on. But keep in mind that this option may take a considerable time, so you should do this only for final releases.
+    * TERRALIB_BUILD_EXAMPLES_ENABLED => OFF
+    * TERRALIB_BUILD_UNITTEST_ENABLED => OFF
+  * Press ''Configure'' again.
+  * Press "Generate": this will generate a solution file for Visual Studio 2013 under the folder ''c:\terralib5\build'' ((The location set in "Where to build the binaries")).
+**5.** Open the solution file located at:
+<code>
+c:\terralib5\build\terralib.sln or press ''Open Project''
+</code>
+**6.** Build ALL_BUILD ((Inside Visual Studio, right click over the project ALL_BUILD and build)), and before running, set it as ''StartUp'' Project and set the local environment of terraview project ((terraview->Properties->Configuration Properties-> Debugging, set the Environment entry as ''PATH=c:\terralib5\3rdparty\lib;c:\<Qt5 path>\bin'')).
+**7.** If TERRALIB_BUILD_EXAMPLES_ENABLED => ON or TERRALIB_BUILD_EXAMPLES_ENABLED => ON: to run and debug one of the terralib_example_* or terralib_unitest_*, set it as ''StartUp'' Project and make sure the data ([[http://www.dpi.inpe.br/terralib5-devel/data/data.zip| data.zip]]) used by these examples/unittest are uncompressed at the default directory specified by TERRALIB_DATA_DIR :
+   TERRALIB_DATA_DIR   C:\terralib\build-win64\data

Trace:

TerraLib and TerraView Wiki Page

Differences

Navigation

Search