Commit cec28ad0 authored by Victor Poughon's avatar Victor Poughon
Browse files

DOC: Cleanup cookbook installation instructions

Remove monteverdi installation instruction
Move to a top level chapter
parent 5b8ea19d
Installation
============
We provide different standalone binary packages for OTB-Applications:
- for Windows platform (7 or higher)
- for 64bit Linux distribution
- for MacOS X
Other binaries can be available as packages (OSGeo packages,
Debian/Ubuntu packages, OpenSuse packages), however be advised that they
may not be up-to-date nor delivered with full features. If you want to
build from source or if we don’t provide packages for your system, some
informations are available into the , in the section (\ Building
from Source)
Windows
-------
We provide for Windows Seven and later through standalone packages. They
are cross-compiled with MinGW, for 32bit and 64bit platforms. They
contain all and their launchers (both command line and graphical
launchers are provided). Check the download page : `OTB Download
page <https://www.orfeo-toolbox.org/download>`__
There is a 32bit and a 64bit version. They contain the same directory
structure:
- ``monteverdi.bat`` : A launcher script for Monteverdi
- ``mapla.bat`` : A launcher script for Mapla
- ``otbenv.bat`` : A script to initialize the environment for OTB
executables
- ``bin`` : A folder containing application launchers (otbcli.bat,
otbgui.bat) and the DLLs.
- ``lib`` : A folder containing application DLLs.
The applications can be launched from the Mapla launcher. If you want to
use the otbcli and otbgui launchers, you can initialize a command prompt
with ``otbenv.bat``.
Linux 64bit
-----------
We provide for Linux 64bit OS through standalone packages. They contain
all OTB Applications and their launchers (both command line and
graphical launchers are provided). Check the download page : `OTB
Download page <https://www.orfeo-toolbox.org/download>`__
This package is a self-extractible archive. You may uncompress it with a
double-click on the file, or with the command line :
::
> chmod +x OTB-&\otbversion&-Linux64.run
> ./OTB-&\otbversion&-Linux64.run
Please note that the resulting installation is not meant to be moved,
you should uncompress the archive in its final location. Once the
archive is extracted, the directory structure is made of :
- ``monteverdi.sh`` : A launcher script for Monteverdi
- ``mapla.sh`` : A launcher script for Mapla
- ``otbenv.profile`` : A script to initialize the environment for OTB
executables
- ``bin`` : A folder containing application launchers (otbcli.sh,
otbgui.sh), Monteverdi and Mapla.
- ``lib`` : A folder containing all shared libraries and OTB
applications.
- ``share`` : A folder containing common resources and copyright
mentions.
In order to run the command line launchers, this package doesn’t require
any special library that is not present in most modern Linux
distributions. The graphical executable (otbgui launchers, Monteverdi
and Mapla) use the X11 libraries, which are widely used in a lot of
distributions :
::
libx11-6 libxext6 libxau6 libxxf86vm1 libxdmcp6 libdrm2
Monteverdi also requires the standard graphics libraries libgl1 and
libglu1. Make sure you have at least one version of them installed
in your system.
The applications can be launched from the Mapla launcher. If you want to
use the otbcli and otbgui launchers, you can initialize your environment
with ``source otbenv.profile``.
MacOS X
-------
We provide for MacOS X through a standalone package. This package is a
self-extractible archive, quite similar to the Linux one. You may
uncompress it with the command line :
::
> chmod +x OTB-&\otbversion&-Darwin64.run
> ./OTB-&\otbversion&-Darwin64.run
Once the archive is extracted, you can see OTB--Darwin64 directory in
the same direcrtory along with OTB--Darwin64.run
Contents of OTB--Darwin64 is briefly listed below:
- ``Monteverdi.app`` : A Mac OSX .app for Monteverdi
- ``Mapla.app`` : A Mac OSX .app for Mapla.
- ``bin`` : A folder containing application launchers (otbcli.sh,
otbgui.sh), monteverdi and mapla binaries.
- ``lib`` : A folder containing all shared libraries and OTB
applications.
- ``share`` : A folder containing common resources and copyright
mentions.
Notes:
- If you want to use the otbcli and otbgui launchers, you must access
them via a terminal prompt.
- The OSX .app are provided for monteverdi (viewer) and mapla
(application browser).
- You must use monteverdi and mapla through their .app files only.
- You are allowed to move these .app files and refrain from moving or
deleting OTB--Darwin64 after extraction. In case you need to have OTB
installed in some other directory. Extract the .run file there.
Other packages
--------------
Warning ! These packages may not be up-to-date with latest OTB
releases. In addition, some features of the library may not be available
on every platform. Some of these are not maintained by OTB-team. If you
want to get involved in the packaging of OTB for your favourite
platform, please contact us through the developer’s mailing list :
otb-developers@googlegroups.com.
Debian
~~~~~~
There are OTB packages for Debian (unstable) since version 5.2.0. OTB
Applications packages may be available as Debian packages through APT
repositories:
- otb-bin for command line applications
- otb-bin-qt for Qt applications
- python-otb for python applications
Due to license issues, the OTB package built in Debian doesn’t contain
6S. As a consequence, the package does not contain the
OpticalCalibration application.
Ubuntu 12.04 and higher
~~~~~~~~~~~~~~~~~~~~~~~
For Ubuntu 12.04 and higher, OTB Applications packages may be available
as Debian packages through APT repositories:
- otb-bin for command line applications
- otb-bin-qt for Qt applications
- python-otb for python applications
Since release 3.14.1, OTB Applications packages are available in the
`ubuntugis-unstable <https://launchpad.net/~ubuntugis/+archive/ubuntugis-unstable>`__
repository.
Since release 5.2.0, the Ubuntu packages derive from the Debian
packages.
You can add it by using these command-lines:
::
sudo aptitude install add-apt-repository
sudo apt-add-repository ppa:ubuntugis/ubuntugis-unstable
After you can run:
::
sudo aptitude install otb-bin otb-bin-qt python-otb
If you are using *Synaptic*, you can add the repositories, update and
install the packages through the graphical interface.
For further informations about Ubuntu packages go to
`ubuntugis-unstable <https://launchpad.net/~ubuntugis/+archive/ubuntugis-unstable>`__
launchpad page and click on Read about installing.
apt-add-repository will try to retrieve the GPG keys of the
repositories to certify the origin of the packages. If you are behind a
http proxy, this step won’t work and apt-add-repository will stall and
eventually quit. You can temporarily ignore this error and proceed with
the update step. Following this, aptitude update will issue a warning
about a signature problem. This warning won’t prevent you from
installing the packages.
OpenSuse 12.X and higher
~~~~~~~~~~~~~~~~~~~~~~~~
For OpenSuse 12.X and higher, OTB Applications packages are available
through *zypper*.
First, you need to add the appropriate repositories with these
command-lines (please replace :math:`11.4` by your OpenSuse version):
::
sudo zypper ar
http://download.opensuse.org/repositories/games/openSUSE_11.4/ Games
sudo zypper ar
http://download.opensuse.org/repositories/Application:/Geo/openSUSE_11.4/ GEO
sudo zypper ar
http://download.opensuse.org/repositories/home:/tzotsos/openSUSE_11.4/ tzotsos
Now run:
::
sudo zypper refresh
sudo zypper install OrfeoToolbox
sudo zypper install OrfeoToolbox-python
Alternatively you can use the One-Click Installer from the `openSUSE
Download
page <http://software.opensuse.org/search?q=Orfeo&baseproject=openSUSE%3A11.4&lang=en&include_home=true&exclude_debug=true>`__
or add the above repositories and install through Yast Package
Management.
There is also support for the recently introduced ’rolling’ openSUSE
distribution named ’Tumbleweed’. For Tumbleweed you need to add the
following repositories with these command-lines:
::
sudo zypper ar
http://download.opensuse.org/repositories/games/openSUSE_Tumbleweed/ Games
sudo zypper ar
http://download.opensuse.org/repositories/Application:/Geo/openSUSE_Tumbleweed/ GEO
sudo zypper ar
http://download.opensuse.org/repositories/home:/tzotsos/openSUSE_Tumbleweed/ tzotsos
and then add the OTB packages as shown above.
MacPort
~~~~~~~
OTB Applications are now available on
`MacPorts <http://http://www.macports.org/>`__. The port name is called
’orfeotoolbox’. You can follow the `MacPorts
documentation < http://guide.macports.org/>`__ to install MacPorts
first, then install the ’orfeotoolbox’ port. After the installation, you
can used directly on your system, the OTB applications.
......@@ -19,206 +19,6 @@ integration of new processing modules.
**Warning** : since version 3.0.0, there is only one , which replaces
monteverdi2 and the original monteverdi 1 (version lower than 1.24.0).
Installation
------------
The application is called , since this is the name of the Orfeo
composer. The application allows you to build interactively remote
sensing processes based on the . This is also in remembering of the
great (and once open source) Khoros/Cantata software.
Installation of is very simple. The standalone packages described for
the installation of (see [sec:appinstall]) also contain and Mapla. Get
the latest information on binary packages on the in the Download
section.
In this section we will focus on alternative ways that are specific for
. We will describe how to install it on:
- for Windows platform (Seven and later)
- for 64bit Linux distribution
- for MacOS X 10.10
If you want to build from source or if we don’t provide packages for
your system, some informations are available into the , in the section
**(**\ Building from Source). Note that the git repository of is located
here : https://git.orfeo-toolbox.org/monteverdi2.git. In order to get
the source of , you will have to checkout the right version. For
instance, use :
::
git checkout 3.0.0-rc1
to get 3.0.0 Release Candidate version.
Windows
~~~~~~~
We provide for Windows Seven and later through standalone packages. They
are cross-compiled with MinGW, for 32bit and 64bit platforms. They
contain with all . These packages are the same as the one used to
install . Check the download page : `OTB Download
page <https://www.orfeo-toolbox.org/download>`__
There is a 32bit and a 64bit version. They contain the same directory
structure:
- ``monteverdi.bat`` : A launcher script for
- ``mapla.bat`` : A launcher script for Mapla
- ``otbenv.bat`` : A script to initialize the environment for OTB
executables
- ``bin`` : A folder containing executable and the DLLs.
- ``lib`` : A folder containing application DLLs.
To launch , simply use the launcher script in the base directory
Linux 64bit
~~~~~~~~~~~
We provide for Linux 64bit OS through standalone packages. They contain
with all OTB Applications. These packages are the same as the one used
to install . Check the download page : `OTB Download
page <https://www.orfeo-toolbox.org/download>`__
This package is a self-extractible archive. You may uncompress it with a
double-click on the file, or with the command line :
::
> sh OTB-5.2.1-Linux64.run
Please note that the resulting installation is not meant to be moved,
you should uncompress the archive in its final location. Once the
archive is extracted, the directory structure is made of :
- ``monteverdi.sh`` : A launcher script for
- ``mapla.sh`` : A launcher script for Mapla
- ``otbenv.profile`` : A script to initialize the environment for OTB
executables
- ``bin`` : A folder containing application launchers (otbcli.sh,
otbgui.sh), Monteverdi and Mapla.
- ``lib`` : A folder containing all shared libraries and OTB
applications.
- ``share`` : A folder containing common resources and copyright
mentions.
In order to run the command line launchers, this package doesn’t require
any special library that is not present in most modern Linux
distributions. The graphical executable (otbgui launchers, Monteverdi
and Mapla) use the X11 libraries, which are widely used in a lot of
distributions :
::
libx11-6 libxext6 libxau6 libxxf86vm1 libxdmcp6 libdrm2
Monteverdi also requires the standard graphics libraries **libgl1** and
**libglu1**. Make sure you have at least one version of them installed
in your system.
To launch , simply use the launcher script in the base directory
MacOS X
~~~~~~~
We provide for MacOS X through a standalone package. This package is a
self-extractible archive, quite similar to the Linux one. You may
uncompress it with the command line :
::
> sh OTB-5.4.0-Darwin64.run
Please note that the resulting installation is not meant to be moved,
you should uncompress the archive in its final location.
Once the archive is extracted, the directory structure is made of :
- ``monteverdi.sh`` : A launcher script for
- ``mapla.sh`` : A launcher script for Mapla
- ``otbenv.profile`` : A script to initialize the environment for OTB
executables
- ``bin`` : A folder containing application launchers (otbcli.sh,
otbgui.sh), Monteverdi and Mapla.
- ``lib`` : A folder containing all shared libraries and OTB
applications.
- ``share`` : A folder containing common resources and copyright
mentions.
To launch , simply use the launcher script in the base directory
Other packages
~~~~~~~~~~~~~~
OSGeo4W
^^^^^^^
For Windows Seven/8.1 users, there is a classical standalone
installation program for , available from the after each release.
It is also possible to get package through for Windows XP/Seven users.
Package for is available directly in the OSGeo4W installer when you
select the **otb-monteverdi** package. Follow the instructions in the
OSGeo4W installer and select the **otb-monteverdi**. The installer will
proceed with the installation of the package and all its dependencies.
will be directly installed in the OSGeo4W repository and a shortcut will
be added to your desktop and in the start menu (in the OSGeo4W folder).
You can now use directly from your desktop, from the start menu and from
an OSGeo4W shell with command ``monteverdi``. Currently, you should use
the 32bit OSGeo4W installer but we will soon distribute package for 64
bit installer.
Ubuntu 12.04 and higher
^^^^^^^^^^^^^^^^^^^^^^^
For Ubuntu 12.04 and higher, package may be available as Debian package
through APT repositories. You can add it by using these command-lines:
::
sudo apt-get install add-apt-repository
sudo apt-add-repository ppa:ubuntugis/ubuntugis-unstable
Now run:
::
sudo apt-get install monteverdi
If you are using *Synaptic*, you can add the repository, update and
install the package through the graphical interface.
**apt-add-repository** will try to retrieve the GPG keys of the
repositories to certify the origin of the packages. If you are behind a
http proxy, this step won’t work and apt-add-repository will stall and
eventually quit. You can temporarily ignore this error and proceed with
the update step. Following this, aptitude update will issue a warning
about a signature problem. This warning won’t prevent you from
installing the packages.
MacOS X DMG
^^^^^^^^^^^
A standard DMG package is available for for MacOS X 10.10. Please go the
. Click on the file to launch .
GUI : what does it look like ?
------------------------------
......
......@@ -95,281 +95,6 @@ The OTB Applications are now rich of more than 40 tools, which are
listed in the the applications reference documentation, presented in
chapter [chap:apprefdoc], page .
Installation
------------
We provide different standalone binary packages for OTB-Applications:
- for Windows platform (7 or higher)
- for 64bit Linux distribution
- for MacOS X
Other binaries can be available as packages (OSGeo packages,
Debian/Ubuntu packages, OpenSuse packages), however be advised that they
may not be up-to-date nor delivered with full features. If you want to
build from source or if we dont provide packages for your system, some
informations are available into the , in the section (\ Building
from Source)
Windows
~~~~~~~
We provide for Windows Seven and later through standalone packages. They
are cross-compiled with MinGW, for 32bit and 64bit platforms. They
contain all and their launchers (both command line and graphical
launchers are provided). Check the download page : `OTB Download
page <https://www.orfeo-toolbox.org/download>`__
There is a 32bit and a 64bit version. They contain the same directory
structure:
- ``monteverdi.bat`` : A launcher script for
- ``mapla.bat`` : A launcher script for Mapla
- ``otbenv.bat`` : A script to initialize the environment for OTB
executables
- ``bin`` : A folder containing application launchers (otbcli.bat,
otbgui.bat) and the DLLs.
- ``lib`` : A folder containing application DLLs.
The applications can be launched from the Mapla launcher. If you want to
use the otbcli and otbgui launchers, you can initialize a command prompt
with ``otbenv.bat``.
Linux 64bit
~~~~~~~~~~~
We provide for Linux 64bit OS through standalone packages. They contain
all OTB Applications and their launchers (both command line and
graphical launchers are provided). Check the download page : `OTB
Download page <https://www.orfeo-toolbox.org/download>`__
This package is a self-extractible archive. You may uncompress it with a
double-click on the file, or with the command line :
::
> chmod +x OTB-&\otbversion&-Linux64.run
> ./OTB-&\otbversion&-Linux64.run
Please note that the resulting installation is not meant to be moved,
you should uncompress the archive in its final location. Once the
archive is extracted, the directory structure is made of :
- ``monteverdi.sh`` : A launcher script for
- ``mapla.sh`` : A launcher script for Mapla
- ``otbenv.profile`` : A script to initialize the environment for OTB
executables
- ``bin`` : A folder containing application launchers (otbcli.sh,
otbgui.sh), Monteverdi and Mapla.
- ``lib`` : A folder containing all shared libraries and OTB
applications.
- ``share`` : A folder containing common resources and copyright
mentions.
In order to run the command line launchers, this package doesnt require
any special library that is not present in most modern Linux
distributions. The graphical executable (otbgui launchers, Monteverdi
and Mapla) use the X11 libraries, which are widely used in a lot of
distributions :
::
libx11-6 libxext6 libxau6 libxxf86vm1 libxdmcp6 libdrm2
Monteverdi also requires the standard graphics libraries libgl1 and
libglu1. Make sure you have at least one version of them installed
in your system.
The applications can be launched from the Mapla launcher. If you want to
use the otbcli and otbgui launchers, you can initialize your environment
with ``source otbenv.profile``.
MacOS X
~~~~~~~
We provide for MacOS X through a standalone package. This package is a
self-extractible archive, quite similar to the Linux one. You may
uncompress it with the command line :
::
> chmod +x OTB-&\otbversion&-Darwin64.run
> ./OTB-&\otbversion&-Darwin64.run
Once the archive is extracted, you can see OTB--Darwin64 directory in
the same direcrtory along with OTB--Darwin64.run
Contents of OTB--Darwin64 is briefly listed below:
- ``Monteverdi.app`` : A Mac OSX .app for Monteverdi
- ``Mapla.app`` : A Mac OSX .app for Mapla.
- ``bin`` : A folder containing application launchers (otbcli.sh,
otbgui.sh), monteverdi and mapla binaries.
- ``lib`` : A folder containing all shared libraries and OTB
applications.
- ``share`` : A folder containing common resources and copyright
mentions.
Notes:
- If you want to use the otbcli and otbgui launchers, you must access
them via a terminal prompt.
- The OSX .app are provided for monteverdi (viewer) and mapla
(application browser).