Skip to content

Commit 0cef6fd

Browse files
committedMay 24, 2017
[processing] minor formatting fixes to the OTB README
(cherry picked from commit 2778a8f)
1 parent e7946b1 commit 0cef6fd

File tree

1 file changed

+16
-12
lines changed
  • python/plugins/processing/algs/otb/maintenance

1 file changed

+16
-12
lines changed
 

‎python/plugins/processing/algs/otb/maintenance/README

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
11
Requirements
22
============
33

4-
QGIS
5-
----
6-
Python plugins
7-
--------------
84
Set OTB environment
95
--------------------
10-
6+
```
117
export PYTHONPATH=/path/to/OTB/install/lib/otb/python/:$PYTHONPATH
128
# Environment variable for old OTB versions (< 5.2)
139
export ITK_AUTOLOAD_PATH=/path/to/OTB/install/lib/otb/applications/
1410
# Environment variable for new OTB versions (>= 5.2)
1511
export OTB_APPLICATION_PATH=/path/to/OTB/install/lib/otb/applications/
1612
# Set LD_LIBRARY_PATH
1713
export LD_LIBRARY_PATH=/path/to/OTB/install/lib/:$LD_LIBRARY_PATH
14+
```
1815

1916
Set QGIS environment
2017
---------------------
18+
19+
```
2120
export QGIS_PREFIX_PATH=/path/to/QGIS/install
2221
export PYTHONPATH=$QGIS_PREFIX_PATH/share/qgis/python:$QGIS_PREFIX_PATH/share/qgis/python/plugins:$PYTHONPATH
2322
# Set LD_LIBRARY_PATH
2423
export LD_LIBRARY_PATH=$QGIS_PREFIX_PATH/lib/:$LD_LIBRARY_PATH
2524
# Add maintenance folder to python path
2625
export PYTHONPATH=/path/to/QGIS/src/python/plugins/processing/algs/otb/maintenance:$PYTHONPATH
26+
```
2727

2828
Check the white and black list for the current OTB version
2929
----------------------------------------------------------
30-
In the maintenance directory, the OTB applications are split in two files black_list.xml and white_list.xml.
31-
These files are organized as follows :
32-
For each OTB version, a new node version with id as attribute is added to the node data.
33-
Each application is then added in the node app_name.
30+
In the maintenance directory, the OTB applications are split in two files `black_list.xml` and `white_list.xml`.
31+
These files are organized as follows. For each OTB version, a new node version with id as attribute is added
32+
to the node data. Each application is then added in the node app_name.
33+
3434
```xml
3535
<?xml version="1.0"?>
3636
<data>
@@ -52,14 +52,18 @@ Each application is then added in the node app_name.
5252
</version>
5353
</data>
5454
```
55+
5556
The list of available applications for each version is not fixed.
5657

5758
OTBSpecific_XMLcreation.py
5859
--------------------------
59-
Warning : Some of the applications needs to be split to be user-friendly. Here comes the file OTBSpecific_XMLcreation.py.
60-
Each function follows the pattern getNameOfTheOTBApplication().
60+
Warning: Some of the applications needs to be split to be user-friendly. Here comes the file `OTBSpecific_XMLcreation.py`.
61+
Each function follows the pattern `getNameOfTheOTBApplication()`.
6162

6263
Creating xml files
6364
------------------
65+
66+
```
6467
cd /path/to/QGIS/src/python/plugins/processing/algs/otb/maintenance
65-
python ./OTBHelper.py
68+
python ./OTBHelper.py
69+
```

0 commit comments

Comments
 (0)
Please sign in to comment.