Skip to content

Commit d01e32e

Browse files
alexbruyDelazJ
authored andcommitted
remove SAGA mentions from the user guide
1 parent 60be2bb commit d01e32e

File tree

2 files changed

+12
-115
lines changed

2 files changed

+12
-115
lines changed

docs/user_manual/introduction/qgis_configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ System environment variables can be viewed, and many configured, in the
262262
platforms, such as Mac, where a GUI application does not necessarily inherit
263263
the user's shell environment. It's also useful for setting and viewing environment
264264
variables for the external tool sets controlled by the Processing toolbox (e.g.,
265-
SAGA, GRASS), and for turning on debugging output for specific sections of the
265+
GRASS), and for turning on debugging output for specific sections of the
266266
source code.
267267

268268
Check |checkbox| :guilabel:`Use custom variables (restart required - include separators)`

docs/user_manual/processing/3rdParty.rst

Lines changed: 11 additions & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Configuring external applications
1010
.. contents::
1111
:local:
1212

13-
The processing framework can be extended using additional applications.
13+
The Processing framework can be extended using additional applications.
1414
Algorithms that rely on external applications are managed by their own
1515
algorithm providers.
1616
Additional providers can be found as separate plugins, and installed
@@ -36,12 +36,12 @@ If you are not an advanced user and you are running QGIS on Windows,
3636
you might not be interested in reading the rest of this chapter.
3737
Make sure you install QGIS in your system using the standalone
3838
installer.
39-
That will automatically install SAGA and GRASS in your system and
40-
configure them so they can be run from QGIS.
41-
All the algorithms from these providers will be ready to be run without
39+
That will automatically install GRASS in your system and configure it so
40+
it can be run from QGIS.
41+
All the algorithms from this provider will be ready to be run without
4242
needing any further configuration.
4343
If installing with the OSGeo4W application, make sure that you also
44-
select SAGA and GRASS for installation.
44+
select GRASS for installation.
4545

4646

4747
A note on file formats
@@ -101,103 +101,6 @@ causes longer execution times.
101101
Using third-party Providers
102102
===========================
103103

104-
.. index:: SAGA
105-
.. _saga_configure:
106-
107-
SAGA
108-
----
109-
110-
SAGA algorithms can be run from QGIS if SAGA is included with the
111-
QGIS installation.
112-
113-
If you are running Windows, both the stand-alone installer and the
114-
OSGeo4W installer include SAGA.
115-
116-
About SAGA grid system limitations
117-
..................................
118-
119-
Most SAGA algorithms that require several input raster layers require
120-
them to have the same grid system.
121-
That is, they must cover the same geographic area and have the same
122-
cell size, so their corresponding grids match.
123-
When calling SAGA algorithms from QGIS, you can use any layer,
124-
regardless of its cell size and extent.
125-
When multiple raster layers are used as input for a SAGA algorithm,
126-
QGIS resamples them to a common grid system and then passes them to
127-
SAGA (unless the SAGA algorithm can operate with layers from different
128-
grid systems).
129-
130-
The definition of that common grid system is controlled by the user,
131-
and you will find several parameters in the SAGA group of the settings
132-
window to do so.
133-
There are two ways of setting the target grid system:
134-
135-
* Setting it manually. You define the extent by setting the values of
136-
the following parameters:
137-
138-
- :guilabel:`Resampling min X`
139-
- :guilabel:`Resampling max X`
140-
- :guilabel:`Resampling min Y`
141-
- :guilabel:`Resampling max Y`
142-
- :guilabel:`Resampling cellsize`
143-
144-
Notice that QGIS will resample input layers to that extent, even if
145-
they do not overlap with it.
146-
* Setting it automatically from input layers.
147-
To select this option, just check the :guilabel:`Use min covering grid
148-
system for resampling` option.
149-
All the other settings will be ignored and the minimum extent that
150-
covers all the input layers will be used.
151-
The cell size of the target layer is the maximum of all cell sizes of
152-
the input layers.
153-
154-
For algorithms that do not use multiple raster layers, or for those that
155-
do not need a unique input grid system, no resampling is performed
156-
before calling SAGA, and those parameters are not used.
157-
158-
Limitations for multi-band layers
159-
.................................
160-
161-
Unlike QGIS, SAGA has no support for multi-band layers.
162-
If you want to use a multiband layer (such as an RGB or multispectral
163-
image), you first have to split it into single-banded images.
164-
To do so, you can use the 'SAGA/Grid - Tools/Split RGB image' algorithm
165-
(which creates three images from an RGB image) or the
166-
'SAGA/Grid - Tools/Extract band' algorithm (to extract a single band).
167-
168-
Limitations in cell size
169-
........................
170-
171-
SAGA assumes that raster layers have the same cell size in the X and
172-
Y axis.
173-
If you are working with a layer with different values for horizontal
174-
and vertical cell size, you might get unexpected results.
175-
In this case, a warning will be added to the processing log, indicating
176-
that an input layer might not be suitable to be processed by SAGA.
177-
178-
Logging
179-
.......
180-
181-
When QGIS calls SAGA, it does so using its command-line interface, thus
182-
passing a set of commands to perform all the required operations.
183-
SAGA shows its progress by writing information to the console, which
184-
includes the percentage of processing already done, along with
185-
additional content.
186-
This output is filtered and used to update the progress bar while the
187-
algorithm is running.
188-
189-
Both the commands sent by QGIS and the additional information printed
190-
by SAGA can be logged along with other processing log messages, and
191-
you might find them useful to track what is going on when QGIS runs a
192-
SAGA algorithm.
193-
You will find two settings, namely :guilabel:`Log console output` and
194-
:guilabel:`Log execution commands`, to activate that logging
195-
mechanism.
196-
197-
Most other providers that use external applications and call them
198-
through the command-line have similar options, so you will find them
199-
as well in other places in the processing settings list.
200-
201104
.. index:: R scripts
202105
.. _r_scripts:
203106

@@ -254,9 +157,9 @@ run these scripts.
254157
Adding R scripts from the QGIS collection
255158
.........................................
256159

257-
R integration in QGIS is different from that of SAGA in that there
258-
is not a predefined set of algorithms you can run (except for some
259-
example script that come with the *Processing R Provider* plugin).
160+
R integration in QGIS is different from that of some other third party providers
161+
like SAGA in that there is not a predefined set of algorithms you can run (except
162+
for some example script that come with the *Processing R Provider* plugin).
260163

261164
A set of example R scripts is available in the QGIS Repository.
262165
Perform the following steps to load and enable them using the
@@ -554,9 +457,8 @@ version 2.0 of the *Processing R Provider* plugin and a fresh install of
554457
GRASS
555458
-----
556459

557-
Configuring GRASS is not much different from configuring SAGA.
558-
First, the path to the GRASS folder has to be defined,
559-
but only if you are running Windows.
460+
Configuring GRASS is very easy. First, the path to the GRASS folder has to be
461+
defined, but only if you are running Windows.
560462

561463
By default, the Processing framework tries to configure its GRASS
562464
connector to use the GRASS distribution that ships along with QGIS.
@@ -572,13 +474,8 @@ correctly installed, and that it can be run without problem
572474
from a terminal window.
573475

574476
GRASS algorithms use a region for calculations.
575-
This region can be defined manually using values similar to the ones
576-
found in the SAGA configuration, or automatically, taking the minimum extent
477+
This region can be defined manually or automatically, taking the minimum extent
577478
that covers all the input layers used to execute the algorithm each time.
578-
If the latter approach is the behavior you prefer, just check the
579-
:guilabel:`Use min covering region` option in the GRASS configuration
580-
parameters.
581-
582479

583480
.. index:: LAStools
584481
.. _lastools_configure:

0 commit comments

Comments
 (0)