You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/sextante/help/_sources/modeler.txt
+42-6Lines changed: 42 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -62,7 +62,7 @@ the modeler window:
62
62
- Boolean value
63
63
64
64
Double-clicking on any of them, a dialog is shown to define its
65
-
characteristics. Depending on the parameter itself, the dialog will
65
+
caracteristics. Depending on the parameter itself, the dialog will
66
66
contain just one basic element (the description, which is what the user
67
67
will see when executing the model) or more of them. For instance, when
68
68
adding a numerical value, as it can be seen in the next figure, apart
@@ -97,7 +97,7 @@ To add an algorithm, double-click on its name. An execution dialog will
97
97
appear, with a content similar to the one found in the execution panel
98
98
that SEXTANTE shows when executing the algorithm from the toolbox. the
99
99
one shown next correspond to the SAGA convergence index algorithm, the
100
-
same one we saw in the section dedicated to the SEXTANTE toolbox.
100
+
same one we saw in the section dedicated to the SEXTANTe toolbox.
101
101
102
102
.. figure:: models_parameters4.png
103
103
:align: center
@@ -114,7 +114,7 @@ you supply will be the description for the output, which will be the one
114
114
the user will see when executing the model.
115
115
116
116
Selecting the value of each parameter is also a bit different, since
117
-
there are important differences between the context of the modeler and
117
+
there are importante differences between the context of the modeler and
118
118
the toolbox one. Let's see how to introduce the values for each type of
119
119
parameter.
120
120
@@ -154,8 +154,7 @@ Elements can be dragged to a different position within the canvas, to
154
154
change the way the module structure is displayed and make it more clear
155
155
and intuitive. Links between elements are update automatically.
156
156
157
-
You can run your algorithm anytime clicking on the *Run* button. However,
158
-
in order to use it from the toolbox, it has to be saved and the modeler dialog closed, to allow the toolbox to refresh its contents.
157
+
You can run your algorithm anytime clicking on the *Run* button. However, in order to use it from the toolbox, it has to be saved and the modeler dialog closed, to allow the toolbox to refresh its contents.
159
158
160
159
Saving and loading models
161
160
-------------------------
@@ -193,6 +192,41 @@ renders all the algorithms in that provider unusable by the modeler,
193
192
which might cause problems when loading models. Keep that in mind when
194
193
you have trouble loading or executing models.
195
194
195
+
Editing a model
196
+
---------------
197
+
198
+
You can edit the model you are currently creating, redefining the workflow and the relationships between the algorithms and inputs that define the model itself.
199
+
200
+
If you right-click on an algorithm in the canvas representing the model, you will see a context menu like the one shown next:
201
+
202
+
.. figure:: modeler_right_click.png
203
+
:align: center
204
+
205
+
206
+
Selecting the *Remove* option will cause the selected algorithm to be removed. An algorithm can be removed only if there are no other algorithms dependind on it. That is, if no output from the algorithm is used in a different one as input. If you try to remove an algorithm that has others depending on it, SEXTANTE will show you a warning message like the one you can see below:
207
+
208
+
.. figure:: cannot_delete_alg.png
209
+
:align: center
210
+
211
+
Selecting the *Edit* option or simply double-clicking on the algorithm icon will show the parameters dialog of the algorithm, so you can change the inputs and parameter values. Not all input elements available in the model will appear in this case as available inputs. Layers or values generated at a more advanced step in the workflow defined by the model will not be available if they cause circular dependencies.
212
+
213
+
Select the new values and then click on the *OK* button as usual. The connections between the model elements will change accordingly in the modeler canvas.
214
+
215
+
Activating and deactivating algorithms
216
+
--------------------------------------
217
+
218
+
Algorithms can be deactivated in the modeler, so they will not be executed once the model is run. This can be used to test just a given part of the model, or when you do not need all the outputs it generates.
219
+
220
+
To deactivate an algorithm, right--click on its icon in the model canvas and select the *Deactivate* option. You will see that the algorithm is represented now with a red label under its name indicating that is not active.
221
+
222
+
.. figure:: deactivated.png
223
+
:align: center
224
+
225
+
All algorithms depending (directly or undirectly) on that algorithm will also appear as inactive, since they cannot be executed now.
226
+
227
+
To activate an algorithm, just right--click on its icon and select the *Activate* option.
228
+
229
+
196
230
Editing model help files and meta-information
197
231
---------------------------------------------
198
232
@@ -218,7 +252,7 @@ if the number of output layers cannot be know in advance), then it is
218
252
not possible to use it within a model, and thus does not appear in the
219
253
list of them that you can find in the modeler dialog.
220
254
221
-
Additionally, you will see some algorithms in the modeler that are not
255
+
Additionaly, you will see some algorithms in the modeler that are not
222
256
found in the toolbox. This algorithms are meant to be used exclusively
223
257
as part of a model, and they are of no interest in a different context.
224
258
The *Calculator* algorithm is an example of that. It is just a simple
@@ -230,6 +264,8 @@ make too much sense.
230
264
SEXTANTE models as Python code
231
265
------------------------------
232
266
267
+
*[This feature is temporarily unavailable]*
268
+
233
269
Along with the tab that contains the graphical design of the model, you
234
270
will find another one containing a Python script which performs the same
235
271
task as the model itself. Using that code, you can create a console
<h1>Welcome to SEXTANTE for QGIS’s documentation!<aclass="headerlink" href="#welcome-to-sextante-for-qgis-s-documentation" title="Permalink to this headline">¶</a></h1>
<h1>SEXTANTE for QGIS’s documentation<aclass="headerlink" href="#sextante-for-qgis-s-documentation" title="Permalink to this headline">¶</a></h1>
52
52
<p>Contents:</p>
53
53
<divclass="toctree-wrapper compound">
54
54
<ul>
@@ -71,6 +71,8 @@ <h1>Welcome to SEXTANTE for QGIS’s documentation!<a class="headerlink" hre
71
71
<liclass="toctree-l2"><aclass="reference internal" href="modeler.html#definition-of-inputs">Definition of inputs</a></li>
72
72
<liclass="toctree-l2"><aclass="reference internal" href="modeler.html#definition-of-the-workflow">Definition of the workflow</a></li>
73
73
<liclass="toctree-l2"><aclass="reference internal" href="modeler.html#saving-and-loading-models">Saving and loading models</a></li>
74
+
<liclass="toctree-l2"><aclass="reference internal" href="modeler.html#editing-a-model">Editing a model</a></li>
75
+
<liclass="toctree-l2"><aclass="reference internal" href="modeler.html#activating-and-deactivating-algorithms">Activating and deactivating algorithms</a></li>
74
76
<liclass="toctree-l2"><aclass="reference internal" href="modeler.html#editing-model-help-files-and-meta-information">Editing model help files and meta-information</a></li>
75
77
<liclass="toctree-l2"><aclass="reference internal" href="modeler.html#about-available-algorithms">About available algorithms</a></li>
76
78
<liclass="toctree-l2"><aclass="reference internal" href="modeler.html#sextante-models-as-python-code">SEXTANTE models as Python code</a></li>
@@ -126,7 +128,7 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
126
128
<divclass="sphinxsidebarwrapper">
127
129
<h3><ahref="#">Table Of Contents</a></h3>
128
130
<ul>
129
-
<li><aclass="reference internal" href="#">Welcome to SEXTANTE for QGIS’s documentation!</a><ul>
131
+
<li><aclass="reference internal" href="#">SEXTANTE for QGIS’s documentation</a><ul>
130
132
</ul>
131
133
</li>
132
134
<li><aclass="reference internal" href="#indices-and-tables">Indices and tables</a></li>
0 commit comments