Commit 62041d42 authored by Rashad Kanavath's avatar Rashad Kanavath
Browse files

Update README.md

parent 904c3b13
#OTB provider for QGIS Processing
# OTB provider for QGIS Processing
Generate OTB qgis descriptors
Descriptor files will be distributed with future releases on OTB starting 6.6.0.
To generate description files for QGIS processing one has to call special target 'generate_qgis_descriptor' from OTB build directory.
This not called by default. This target run ./bin/otbQgisDescriptor for all otb application available in current build and write output
to BINARY\_DIR/descriptors. It then copies BINARY\_DIR/descriptors to INSTALL\_DIR/descriptors.
list of application depends on property of internal cmake variable "OTB\_APPLICATIONS\_NAME\_LIST".
## Installation using QGIS plugin manager
Please refer to manual installation. This plugin will be moved to qgis processing core after intial testing.
Installation
Using QGIS Plugin manager
(not published)
## Manual Installation
Manual
1. download plugin
cd $HOME/projects
Clone qgis-otb-plugin repository and set QGIS_PLUGINPATH.
### For Linux/Unix/MacOSX
```
mkdir $HOME/projects; cd $HOME/projects
git clone https://gitlab.orfeo-toolbox.org/orfeotoolbox/qgis-otb-plugin
2. install otb plugin
export QGIS_PLUGINPATH=$HOME/projects/qgis-otb-plugin
```
### For Windows
Clone qgis-otb-plugin repository to `c:\qgis-plugins\qgis-otb-plugin`
`git clone https://gitlab.orfeo-toolbox.org/orfeotoolbox/qgis-otb-plugin`
#### Set `QGIS_PLUGINPATH`
* System properties (`Windows Key + R -> sysdm.cpl` )
* Select Advanced Tab -> Environment variables.
* Under "user variables for "
* Add or Edit variable `QGIS_PLUGINPATH` and set value to `C:\qgis-plugins\qgis-otb-plugin`
### Configure pluign in QGIS
3. configure pluign
#### Start QGIS and open processing settings
`Settings -> Options -> Processing (left panel)`
3.1. Start qgis
You can see OTB under "Providers".
3.2. Settings -> Options -> Processing (left panel)
You can see OTB section under "Providers".
* Expand OTB tab
* Tick Activate option
* Set OTB folder entry. This is location of your otb installation.
* Set OTB application folder entry. This is location of your otb applications. It is relative to otb folder `<OTB_FOLDER>/lib/otb/applications`. Multiple paths are allowed to use custom otb apps.
3.3. expand OTB tab,
3.3.1 check on Activate
3.3.2 set OTB folder entry. This is location of your otb installation.
3.3.3 set OTB application folder entry. This is location of your otb application and is relative to otb installation
Here is an example of OTB folder and OTB application folder:
```
OTB applications folder /home/rashad/projects/otb/build/lib/otb/applications
OTB folder /home/rashad/projects/otb/build
````
3.4 Click "ok" to save settings and close dialog. If settings are correct, you will have otb algorithms loaded now
* Click "ok" to save settings and close dialog. If settings are correct, you will have otb algorithms loaded in Processing toolbox
Tested with QGIS master (since 5b7b7be6e7)
OTB 6.5 (branch: wrapper_qgis)
OTB 6.6 (branch: wrapper_qgis)
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