sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-06-21 00:03:03 -04:00
Code Issues Packages Projects Releases Wiki Activity

[processing] minor formatting fixes to the OTB README

Browse Source
This commit is contained in:
Alexander Bruy 2016-10-19 17:23:24 +03:00
parent fd8379c140
commit 2778a8fe8c
1 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
python/plugins/processing/algs/otb/maintenance/README
View File

@ -1,13 +1,9 @@
Requirements
============
QGIS
----
Python plugins
--------------
Set OTB environment
--------------------
```
export PYTHONPATH=/path/to/OTB/install/lib/otb/python/:$PYTHONPATH
# Environment variable for old OTB versions (< 5.2)
export ITK_AUTOLOAD_PATH=/path/to/OTB/install/lib/otb/applications/
@ -15,22 +11,26 @@ export ITK_AUTOLOAD_PATH=/path/to/OTB/install/lib/otb/applications/
export OTB_APPLICATION_PATH=/path/to/OTB/install/lib/otb/applications/
# Set LD_LIBRARY_PATH
export LD_LIBRARY_PATH=/path/to/OTB/install/lib/:$LD_LIBRARY_PATH
```
Set QGIS environment
---------------------
```
export QGIS_PREFIX_PATH=/path/to/QGIS/install
export PYTHONPATH=$QGIS_PREFIX_PATH/share/qgis/python:$QGIS_PREFIX_PATH/share/qgis/python/plugins:$PYTHONPATH
# Set LD_LIBRARY_PATH
export LD_LIBRARY_PATH=$QGIS_PREFIX_PATH/lib/:$LD_LIBRARY_PATH
# Add maintenance folder to python path
export PYTHONPATH=/path/to/QGIS/src/python/plugins/processing/algs/otb/maintenance:$PYTHONPATH
```
Check the white and black list for the current OTB version
----------------------------------------------------------
In the maintenance directory, the OTB applications are split in two files black_list.xml and white_list.xml.
These files are organized as follows :
For each OTB version, a new node version with id as attribute is added to the node data.
Each application is then added in the node app_name.
In the maintenance directory, the OTB applications are split in two files `black_list.xml` and `white_list.xml`.
These files are organized as follows. For each OTB version, a new node version with id as attribute is added
to the node data. Each application is then added in the node app_name.
```xml
<?xml version="1.0"?>
<data>
@ -52,14 +52,18 @@ Each application is then added in the node app_name.
</version>
</data>
```
The list of available applications for each version is not fixed.
OTBSpecific_XMLcreation.py
--------------------------
Warning : Some of the applications needs to be split to be user-friendly. Here comes the file OTBSpecific_XMLcreation.py.
Each function follows the pattern getNameOfTheOTBApplication().
Warning: Some of the applications needs to be split to be user-friendly. Here comes the file `OTBSpecific_XMLcreation.py`.
Each function follows the pattern `getNameOfTheOTBApplication()`.
Creating xml files
------------------
```
cd /path/to/QGIS/src/python/plugins/processing/algs/otb/maintenance
python ./OTBHelper.py
python ./OTBHelper.py
```