TerraLib and TerraView Wiki Page

You are here: start » wiki » terralib5_build

Differences

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

--- wiki:terralib5_build [2014/08/13 16:26]
marisa [TerraLib 5.0.0-alpha - Build and Install]
+++ wiki:terralib5_build [2014/09/25 16:41] (current)
marisa
@@ Line 1: / Line 1: @@
-====== TerraLib 5.0.0-alpha - Build and Install ======
+====== TerraLib 5.0 - General guide for Building and Install ======
 Useful links:
-  * [[wiki:terralib5_build#Cmake-GUI| Using the Cmake-GUI]]
+  * [[wiki:terralib5_build#CMake_Command_Line_Notes| Using Cmake Command line]]
-  * [[wiki:terralib5_build#Cmake_Command_Line| Using Cmake Command line]]
-  * [[wiki:terralib5_build#ccmake| Using Ccmake]]
-  * [[wiki:terralib5_build#building_the_examples| Examples]]
 ===== Building Terralib =====
-This section explains how to build the TerraLib from source code in some platforms. The original instructions are in BUILD-INSTRUCTIONS file at the terralib codebase.
+This section explains how to build the TerraLib from source code in some platforms. The most updated instructions are in BUILD-INSTRUCTIONS file located at the root of the terralib codebase directory. Here are the general instructions and might not have all variables needed for a specific release.
+==== 1. Build instructions on Linux with g++ (GNU gcc) ====
+-----------------------------------------------------------
+.1. Open a Command Prompt (Shell).
+.2. We will assume that the codebase (all the source tree) is located at:
+/home/user/terralib/codebase
+.3. Create a folder out of the terralib source tree, for example:
+  $ cd /home/user/terralib
+  $ mkdir build-linux
+  $ cd build-linux
+.4. For Linux systems you must choose the build configuration:
+  $ cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE:STRING="Release" -DCMAKE_INSTALL_PREFIX:PATH="/usr/local/terralib" ../codebase/build/cmake
+Notes:
+  a) Some Linux flavours with different versions of GNU gcc and Boost will need more parameters such as:
+          -DCMAKE_PREFIX_PATH:PATH="/usr/local;/opt/include"
+          -DCMAKE_INCLUDE_PATH:PATH="/usr/local;/opt/include"
+          -DCMAKE_LIBRARY_PATH:PATH="/usr/local;/opt/lib"
+          -DCMAKE_PROGRAM_PATH:PATH="/usr/local/bin;/opt/bin"
+          -DBOOST_ROOT:PATH="/opt/boost"
+  b) Boost can also be indicated by BOOST_INCLUDEDIR (note: without an '_' separating INCLUDE and DIR):
+          -DBOOST_INCLUDEDIR:PATH="/usr/local/include"
+  c) The parameter -lpthread must be informed only if your Boost was not built as a shared library:
+          -DCMAKE_CXX_FLAGS:STRING="-lpthread"
+  d) For building with Qt5 you can provide the Qt5_DIR variable as:
+          -DQt5_DIR:PATH="/usr/local/lib/cmake/Qt5"
+  e) For generating a debug version set CMAKE_BUILD_TYPE as:
+          -DCMAKE_BUILD_TYPE:STRING="Debug"
+.5 Building:
+  $ make -j 4
+.6 Installing:
+  $ make install
+==== 2. Building with CMake GUI ====
+--------------------------
+.1 On Windows:
 a) We will assume that the TerraLib source tree (git clone) is located at:
@@ Line 56: / Line 108: @@
 j) To run and debug terraview application, set it as StartUp Project at Microsoft Visual C++ 2010.
-k) To run and debug examples and/or unittests make sure the data used are located at the default directory:
+k) To run and debug examples and/or unittests make sure the data (http://www.dpi.inpe.br/terralib5-devel/data.zip) used are located at the default directory:
    TERRALIB_DATA_DIR   C:\terralib\build-win32\data
 l) Make sure the default directory used to save the reports generated by the unittests exist, otherwise no report will be saved:
    TERRALIB_REPORT_DIR   C:\terralib\build-win32\report
+.2 On MacOs and Linux:
-For more information on TerraLib, please, visit its main web page at: http://www.terralib.org.
+a) We will assume that the TerraLib source tree (git clone) is located at:
+   /home/user/terralib5
-==== Cmake-Gui  ====
+b) We wil assume that the build tree where will be generated the binaries is located at:
+   /home/user/build_terralib5
-Using the Graphic Interface (cmake-gui) to build the compilation projects.
+c) We will assume that all the third-party libraries that TerraLib needs to be compiled are installed in your system, and the Qt5 version is used.
-To run CMake from the cmake-gui, you will:
+d) Open CMake-GUI in order to generate a build project for MacOS or Linux:
-  * Execute the cmake-gui system, found in the CMake binary folder.
+e) Then assure that the following variables are set to the locations defined above:
+   Where is the source code => /home/user/terralib5
+   Where to build the binaries => /home/user/build_terralib5
-  * In the "Where is the source code", put the path where is the CMakeLists main file. For terralib it is <terralib_root>/build
+f) Then press the Add Entry button containing the following CMake variables:
+   Name: CMAKE_PREFIX_PATH
+   Type: PATH
+   Value: /qt5_install_dir/lib/cmake/Qt5          and
+   Name: CMAKE_BUILD_TYPE
+   Type: String
+   Value: Release(or Debug)
+g) Then press "Configure" button. If it is the first time that you press this button, select the Generator to be used (Makefile or a selected IDE like Eclipse for Linux, or XCode for MacOS)
+Note: Some projects may be disabled through the following variables:
+        TERRALIB_BUILD_EXAMPLES_ENABLED => OFF
+        TERRALIB_BUILD_UNITTEST_ENABLED => OFF
-  * In the "Where to build the binaries", put the path where you want the CMake generate the files. For terralib it can be <building_dir>/terralib.
+h) According to the generator selected previously, in the build tree directory(/home/user/build_terralib5) will be generated a Makefile or the file corresponding to the IDE selected.
-  * (Optional) Set up the TE_DEPENDENCIES_DIR. Press the Add Entry button and adjust the path to the dependencies directory, for example:
+i) TerraLib/TerraView can be compiled calling make for the Makefile Generator, Eclipse (for Linux) or XCode (for MacOS).
-{{ :wiki:add-entry.png?400 |}}
+j) To run and debug terralib_example_* and/or terralib_unittest_* make it the current project and make sure the data (http://www.dpi.inpe.br/terralib5-devel/data.zip) used are located at the build directory:
+   TERRALIB_DATA_DIR   /home/user/build_terralib5/data
+k) Make sure the default directory used to save the reports generated by the terralib_unittest_* exists, otherwise no report will be saved:
+   TERRALIB_REPORT_DIR   /home/user/build_terralib5/report
-  *  Click "Configure" and select the generator for the project.
+For more information on TerraLib, please, visit its main web page at: http://www.terralib.org.
-  * Review the "BUILD" group and check which module you want to build.
-  * Review the options related to third-party libraries (e.g. "Boost" or "Gdal") and make sure that CMake found the needed library file(s) and include directoriy. If any of the dependencies is not found you must manually enter the path to it. Just click on the line of the dependency and type the path.
-  * Click "Generate"
-After these steps, the build files will have been generated and the cmake-gui will look like this:
-{{ :wiki:cmake-gui.png?1080 |}}
-Now all you need to do is go to the selected building directory and run the appropriate building tool according to the generator you selected. (e.g. for Unix Makefiles just run "make").
-==== CMake command line ====
+==== CMake command line notes====
 Using the CMake command line to build the compilation projects.
@@ Line 106: / Line 170: @@
 ^Variable^Effect^Example^
 | CMAKE_BUILD_TYPE | Sets the build type. Such as Debug or Release | -DCMAKE_BUILD_TYPE=Debug |
-| BUILD_TERRALIB4 | Enable/disable [ON/OFF] the TerraLib4 module | -DBUILD_TERRALIB4=OFF |
 | QWT_INCLUDE_DIR | Sets the include path of the QWT library | -DQWT_INCLUDE_DIR=<DIRECTORY> |
 | QWT_LIBRARY_DEBUG | Sets the path of the QWT library in Debug | -DQWT_LIBRARY_DEBUG=<LIBRARY_FILE_PATH> |
 | QWT_LIBRARY_RELEASE | Sets the path of the QWT library in Release | -DQWT_LIBRARY_RELEASE=<LIBRARY_FILE_PATH> |
-| TE_DEPENDENCIES_DIR | Used as an easy and convenient way to locate terralib's dependencies | -DTE_DEPENDENCIES_DIR=<unpack_dir>/terralib_3rdparty_win32 |
 | LOG4CXX_INCLUDE_DIR | Log4Cxx headers include path | -DLOG4CXX_INCLUDE_DIR=<DIRECTORY> |
 | LOG4CXX_LIBRARY_DEBUG | Log4Cxx debug library file path | -DLOG4CXX_LIBRARY_DEBUG=<LIBRARY_FILE_PATH> |
@@ Line 137: / Line 199: @@
 A few examples of how to call CMake to build terralib:
+  * Calling from a building dir while pointing to the source (main CmakeLists location), specifying Unix Makefiles as a generator, compiling in Release
+  $ cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX:PATH="/usr/local/terralib" ../codebase/build/
   * Specifying Visual Studio 10 as the generator, using source code located at C:\Dev\Terralib\build and setting the option to generate a NSIS installer as true:
-cmake -G 'Visual Studio 10' C:\Dev\Terralib\build -DTE_DEPENDENCIES_DIR=C:/Libs/terralib_3rdparty_win32 -DCPACK_BINARY_NSIS=True
+  $ cmake -G 'Visual Studio 10' C:\Dev\Terralib\build -DTE_DEPENDENCIES_DIR=C:/Libs/terralib_3rdparty_win32 -DCPACK_BINARY_NSIS=True
   * Calling from a building dir while pointing to the source (main CmakeLists location), specifying Unix Makefiles as a generator, compiling in Release and adjusting the QWT references to the path of a locally compiled version:
-cmake -G 'Unix Makefiles' /home/<user>/terralib5/build -DCMAKE_BUILD_TYPE=Release -DQWT_INCLUDE_DIR=/usr/local/qwt-6.1.0/ include -DQWT_LIBRARY_RELEASE=/usr/local/qwt-6.1.0/lib/libqwt.so.6.1.0
+  $ cmake -G 'Unix Makefiles' /home/<user>/terralib5/build -DCMAKE_BUILD_TYPE=Release -DQWT_INCLUDE_DIR=/usr/local/qwt-6.1.0/include -DQWT_LIBRARY_RELEASE=/usr/local/qwt-6.1.0/lib/libqwt.so.6.1.0
 == Notes for Linux build ==
@@ Line 153: / Line 219: @@
 | LD_LIBRARY_PATH | A colon-separated set of directories where third party libraries should be searched for first, before the standard set of directories | LD_LIBRARY_PATH=/home/user/mylibraries |
-==== CCmake ====
-Using the curses based Interface (ccmake) to build the compilation projects.
-On some Unix platforms, you can install a curses based cmake gui that is a terminal based text application and can be used as well. The commands are basically the same as before, but instead of using "cmake" use "ccmake" instead.
-Example: ccmake /home/<username>/source/terralib5/build (Executed from the <building_dir>)
-{{ :wiki:ccmake.png?1080 |}}
-Once executed, the user can manually adjust the variables and customize the compilation. Once the options have been adjusted type c to configure the project and then type g to generate the build files and exit ccmake.
-===== Building the Examples =====
-This section will detail the proccess of building the examples after building or installing Terralib. Some examples are listed here:
-^  Folder  ^  Content   ^
-| example_ado| It shows how to interact with Microsoft Access driver. |
-| example_dataaccess| It shows how to interact with DataAccess Module and drivers PostGIS, ORG and GDAL|
-| example_geometry| It shows how to create geometries and some Spatial Operators.|
-| terralib_raster| It shows how to manipulate raster data.|
-| example_rp| It show how use the raster processing module.|
-| example_srs| It shows how to use the sapatial reference system manager. |
-| example_st| It show how to use the Spatial Temporal Module.|
-| example_vp| It shows how to use the Vector Processing Module.|
-The proccess is similar to Terralib's proccess, steps such as using the cmake-gui or command line are similar, however, there a few differences worth mentioning.
-First, in order to build either the examples cmake must be told where is the CMakeLists main file which is <terralib_root>/build/examples.
-Also, examples use a few variables that can edited, they are:
-^Variable^Comment^Value^
-|terralib_DIR | Where terralib has been built/installed | it can either  be defined as an environmental variable or be defined at the CMake interface using the Add Entry button, type PATH, value <building_dir>/terralib |
-| DATA_DIR  | where the data used by the examples will be downloaded and unpacked  | Inform the path where you downloaded the http://www.dpi.inpe.br/terralib5/data.zip |
-After pressing ''Configure'', Review the "EXAMPLE" group and check which example you want to build. Some are already checked and you can keep or change the examples that will be compiled, for example:
-{{:wiki:examples-compilation.png|}}
-You can edit these variables in the same way used to configure terralib's variables.
-Once you are done, just ''Configure'' and ''Generate'' the build files in the same way explained on the terralib section.

Trace:

TerraLib and TerraView Wiki Page

Differences

Navigation

Search