Commit 1f8de8a3 authored by Rashad Kanavath's avatar Rashad Kanavath

Update README.md

parent 6eb17c41
# OTB provider for QGIS Processing
**OTB provider will be available in processing core starting from qgis 3.8.**
## Installation using QGIS plugin manager
Please refer to manual installation. This plugin will be moved to qgis processing core after intial testing.
## Manual Installation
Clone qgis-otb-plugin repository and set QGIS_PLUGINPATH.
## Version
* QGIS : 3.2.0 or later
* OTB : 6.6.0 or later
### For Linux/Unix/MacOSX
```
mkdir $HOME/projects; cd $HOME/projects
git clone https://gitlab.orfeo-toolbox.org/orfeotoolbox/qgis-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`
## Requirements
#### 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`
Make sure you don't have reference to clone of this repository in your QGIS_PLUGINPATH.
### Download and Install OTB
......@@ -36,17 +20,27 @@ Download OTB: https://www.orfeo-toolbox.org/download/
Git repository: https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb
### Configure plugin in QGIS
## Installation
Install through QGIS plugin manager. This plugin is available in OTB's plugin repository located at orfeo-toolbox.org/qgis/
#### Start QGIS
If you already have QGIS opened, you must restart it.
Open plugin manager through menu. `Plugins -> Manage and Install Plugins `
* Select settings on left pane.
* Click `Add..` button to open the dialog box for adding a new plugin repository
* Write name for repository. eg: `OTB plugin repository`
* Write `http://orfeo-toolbox.org/qgis/plugins.xml` as URL
* Click `OK` to close dialog
* Select `New` or `Upgradable` from left pane. You can now see `Processing OTB Provider` in the list of plugins
* Select `Processing OTB Provider` and click on `Install plugin` to download and install otb processing
#### Install otb plugin
#### Verify otb plugin installation
`Plugins -> Manage and Install Plugins `
Click on `Installed` tab on left and make sure box next to `OrfeoToolBox(OTB)` is checked.
Click on `Installed` tab on left and make sure box next to `Processing OTB provider` is checked.
#### Open processing settings
......@@ -78,6 +72,23 @@ This is the location(s) of OTB applications.
Multiple paths are allowed to use custom/proprietary OTB applications.
##### Logger level (optional)
Level of logger to use by OTB applications. level of logging control amount of details printed during algorithm execution.
Possible values for logger level are INFO, WARNING, CRITICAL, DEBUG. you can refer to otb::Logger documentation for more on this values
*This value is INFO by default.*
**This is an advanced user configuration.**
##### Maximum RAM to use (optional)
By default otb application use system RAM as available. you can however instruct otb to use specific amount of RAM from available using this option.
*A value of `128` is ignored by OTB processing provider.*
**This is an advanced user configuration.**
##### Geoid file (optional)
Path to geoid file.
......@@ -85,7 +96,7 @@ Value of this options is set for `elev.dem.geoid` and `elev.geoid` parameters in
Setting this value globally help users to share it across multiple processing algorithms.
This value is empty by default.
*This value is empty by default.*
##### SRTM tiles folder (optional)
......@@ -97,13 +108,8 @@ Value of this options is set for `elev.dem.path` and `elev.dem` parameters in OT
Setting this value globally help users to share it across multiple processing algorithms.
This value is empty by default.
*This value is empty by default.*
See OTB issue for a related feature request in OTB QtWidget wrapper. https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb/issues/1560
##### Version
* QGIS : 3.0.2 or later
* OTB : 6.6.0 or later
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