README 6.59 KB
Newer Older
Jordi Inglada's avatar
Jordi Inglada committed
1 2
This is the ORFEO Toolbox README file.
Please see the Copyright directory for legal issues on the use of the software.
Jordi Inglada's avatar
Jordi Inglada committed
3
Install information is available in the OTB Software Guide which can be downloaded from http://otb.cnes.fr.
Jordi Inglada's avatar
Jordi Inglada committed
4 5 6 7 8

Thank you.

The OTB Development Team.

Jordi Inglada's avatar
Jordi Inglada committed
9 10


11 12 13 14

***Notes for those who do not read the doc***

We assume that you will install everything on a directory called
Jordi Inglada's avatar
Jordi Inglada committed
15 16
INSTALL_DIR, which usually is /usr/local, /home/jordi/local or
whatever you want.
17 18

Make sure that you have downloaded the source code for:
Jordi Inglada's avatar
Jordi Inglada committed
19 20 21 22
       - CMake (http://www.cmake.org)
       - GDAL (http://www.gdal.org/)
       - Fltk (http://www.fltk.org)

23 24 25
Installation on Linux/Unix platforms
------------------------------------

Emmanuel Christophe's avatar
Emmanuel Christophe committed
26 27
NB: On some linux plateforme, you may (and should) use the official distribution packages for gdal, cmake and fltk

28
1. Install GDAL:
Jordi Inglada's avatar
Jordi Inglada committed
29
      cd INSTALL_DIR
Emmanuel Christophe's avatar
Emmanuel Christophe committed
30 31 32
      gunzip gdal.1.5.1.tar.gz
      tar xvf gdal.1.5.1.tar
      cd gdal.1.5.1
Jordi Inglada's avatar
Jordi Inglada committed
33 34 35 36
      ./configure --prefix=INSTALL_DIR
      make
      make install

37
2. Install CMake:
Jordi Inglada's avatar
Jordi Inglada committed
38
      cd INSTALL_DIR
39 40 41
      gunzip cmake-2.4.7.tar.gz
      tar xvf cmake-2.4.7.tar
      cd cmake-2.4.7
Jordi Inglada's avatar
Jordi Inglada committed
42 43 44 45 46 47 48
      ./configure --prefix=INSTALL_DIR
      make
      make install

      In order to properly use cmake, add INSTALL_DIR/bin to your path
      with export PATH=$PATH:INSTALL_DIR/bin or something similar.

49
3. Install Fltk using CMake (do not use the configure script)
Jordi Inglada's avatar
Jordi Inglada committed
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66

      cd INSTALL_DIR
      bunzip2 fltk-1.1.7-source.tar.bz2 OR
      gunzip fltk-1.1.7-source.tar.gz
      mkdir Fltk-binary
      cd Fltk-binary
      ccmake ../fltk-1.1.7
      --> follow the CMake instructions, in particular:
          --> set CMAKE_INSTALL_PREFIX to INSTALL_DIR within CMake
	  --> set BUILD_EXAMPLES to ON within CMake
	  --> generate the configuration with 'g'
      make
      make install
      --> check that the examples located in
      INSTALL_DIR/Fltk-binary/bin work, in particular, the fractals
      example which makes use of the OpenGL library needed by OTB.

67
4. Install OTB
Jordi Inglada's avatar
Jordi Inglada committed
68 69

      cd INSTALL_DIR
Emmanuel Christophe's avatar
Emmanuel Christophe committed
70 71
      gunzip OrfeoToolbox-2.4.0.tgz
      tar xvf OrfeoToolbox-2.4.0.tar
Jordi Inglada's avatar
Jordi Inglada committed
72 73
      mkdir OTB-Binary
      cd OTB-Binary
Emmanuel Christophe's avatar
Emmanuel Christophe committed
74
      ccmake ../OrfeoToolbox-2.4.0
Jordi Inglada's avatar
Jordi Inglada committed
75 76 77 78 79 80 81 82 83 84 85 86
      --> follow the CMake instructions, in particular:
	  --> set BUILD_EXAMPLES to ON within CMake
	  --> set BUILD_SHARED_LIBS to OFF within CMake
	  --> set BUILD_TESTING to OFF within CMake
	  --> set CMAKE_INSTALL_PREFIX to INSTALL_DIR within CMake
	  --> set GDAL_INCLUDE_DIRS to INSTALL_DIR/include within CMake
	  --> set GDAL_LIBRARY_DIRS to INSTALL_DIR/lib within CMake
	  --> set OTB_USE_EXTERNAL_ITK to OFF within CMake
	  --> set FLTK_DIR to INSTALL_DIR/Fltk-Binary within CMake
	  --> generate the configuration with 'g'
       make
       make install
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
      

Installation on Microsoft Visual Studio .NET 2003 (7.1)
-------------------------------------------------------

1. Install GDAL

	MSVC++ 7.1 project files are needed to compile GDAL.
	These files can be downloaded at http://vterrain.org/dist/gdal132_vc71.zip.
	Then, unzip it to your GDAL folder, and it will create a folder (named "VisualStudio").
	Load the solution (.sln file) and build the gdal project.
	More details can be found at http://vterrain.org/Distrib/gdal.html.

2. Install Fltk

	Use CMake on Windows to generate MSVC++ 7.1 project files from fltk sources.
	Open the solution and build the fltk project.

3. Install OTB

	Use CMake on Windows to generate MSVC++ 7.1 project files from otb sources.
		Open the solution and build the otb project.


Installation on Microsoft Visual Studio .NET 2005 (8.0)
-------------------------------------------------------

1. Install GDAL

        Open a MS-DOS prompt.
        Run the VCVARS32.bat script that comes with the compiler (it can be found in 
        Microsoft Visual Studio 8/VC/bin).
        Then, go to the GDAL root directory, and tape : 
                nmake /f makefile.vc
        Once the build is successful, tape this line to install GDAL :
                nmake /f makefile.vc install
   
        More details about this install can be found at www.gdal.org/gdal_building.html.
                
2. Install Fltk

	Use CMake on Windows to generate MSVC++ 8.0 project files from fltk sources.
	Open the solution and build the fltk project.

3. Install OTB

	Use CMake on Windows to generate MSVC++ 8.0 project files from otb sources.
	Open the solution and build the otb project.


Installation with MinGW on Windows platform
-------------------------------------------

0. Install MinGW

	Download the lastest version of mingw and msys at http://www.mingw.org and install those 
	two programs.
	Then, launch MinGW : a promp appears (similar to Linux one).

1. Install GDAL
Jordi Inglada's avatar
Jordi Inglada committed
147

148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
	To compile GDAL, at configure step, use these options :
		./configure -prefix=INSTALL_DIR --host=mingw32 --without-libtool 
		--without-python --with-png=internal --with-libtiff=internal
		--with-jpeg=internal

	Then lauch the usual make and make install.

2. Install Fltk

	Generate MSYS Makefiles with CMake (Windows version) from fltk sources.
	Then, under prompt, tape make and make install where you have generated Makefiles with CMake.

3. Install OTB

	Similar to fltk install.


Installation on Cygwin platform
-------------------------------

0. Install Cygwin

	Download the lastest version at http://www.cygwin.com and install it.
	Then, launch it, a prompt appears (similar to Linux one).

1. Install GDAL

	To compile GDAL, at configure step, use these options :
		./configure --prefix=INSTALL_DIR --with-png=internal --with-libtiff=internal
		--with-jpeg=internal

	Then lauch the usual make and make install.

2. Install Fltk

	See Linux part for details (same procedure).

3. Install OTB

	See Linux part for details (same procedure).




That should be all! Otherwise, subscribe to
Jordi Inglada's avatar
Jordi Inglada committed
193
   otb-users@googlegroups.com and you will get some help.
194

Jordi Inglada's avatar
Jordi Inglada committed
195 196


197 198 199 200 201 202
** Sun OS ans HP UX users **
----------------------------

Please make sure that you use the GNU tar command, since the tar
command shipped with Sun workstations may give problems. See
<http://groups.google.com/group/otb-users/browse_thread/thread/3758159f06092ae4>
203 204 205 206 207 208 209
for details.


** Cygwin users **
------------------

Due to an unknown bug, Fltk can't compile on some versions of Cygwin (OpenGL problems).
210
Put OTB_USE_VISU_GUI to OFF to avoid these problems.
211 212 213 214 215 216 217 218 219 220 221 222

Some bugs can appear while compiling GDAL with JPEG2000 files : disable this format to resolve the problem.


** Microsoft Visual Studio .NET 2005 (8.0) users **
---------------------------------------------------

Execution errors can appear on some platforms, using GDAL compiled with MSVC++ 8.0.

This problem can be resolved by downloading GDAL binaries for Windows
at http://vterrain.org/Distrib/gdal.html.