Skip to content

Commit bad0567

Browse files
committed
Add the "Run selected steps" and "Run from here" options
Fixes #9080
1 parent eb97b98 commit bad0567

File tree

4 files changed

+31
-9
lines changed

4 files changed

+31
-9
lines changed

docs/documentation_guidelines/substitutions.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ Icon Substitution Icon
501501
============================== ================================== ============================== ==================================
502502
|processingAlgorithm| ``|processingAlgorithm|`` |processingModel| ``|processingModel|``
503503
|processingHistory| ``|processingHistory|`` |processingResult| ``|processingResult|``
504-
|menu| ``|menu|``
504+
|menu| ``|menu|`` |runSelected| ``|runSelected|``
505505
|processSelected| ``|processSelected|`` |editHelpContent| ``|editHelpContent|``
506506
|saveAsPython| ``|saveAsPython|`` |modelOutput| ``|modelOutput|``
507507
|qgsProjectFile| ``|qgsProjectFile|`` |addToProject| ``|addToProject|``
@@ -1460,6 +1460,8 @@ Icon Substitution Icon
14601460
:width: 1.5em
14611461
.. |runConsole| image:: /static/common/iconRunConsole.png
14621462
:width: 1.5em
1463+
.. |runSelected| image:: /static/common/mActionRunSelected.png
1464+
:width: 1.5em
14631465
.. |saveAsPDF| image:: /static/common/mActionSaveAsPDF.png
14641466
:width: 1.5em
14651467
.. |saveAsPython| image:: /static/common/mActionSaveAsPython.png

docs/user_manual/processing/modeler.rst

+26-8
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,10 @@ Model menu
5757
- :kbd:`F5`
5858
- |checkbox|
5959
- Executes the model
60+
* - |runSelected| :guilabel:`Run Selected Steps...`
61+
- :kbd:`Shift+F5`
62+
-
63+
- Runs only the selected steps in a model, allowing to run a subset of the model
6064
* - :guilabel:`Reorder Model Inputs...`
6165
-
6266
-
@@ -479,14 +483,26 @@ model comments. Comments are visible only in the modeler canvas and not
479483
in the final algorithm dialog; they can be hidden by deactivating
480484
:menuselection:`View --> Show Comments`.
481485

482-
You can run your algorithm any time by clicking on the |start| :sup:`Run model` button.
483-
When using the editor to execute a model, any non-default values will be
484-
saved in the inputs. This means that executing the model at a later time from
485-
the editor will have the dialog prefilled with those values on any subsequent run.
486-
487-
In order to use the algorithm from the toolbox, it has to be saved
488-
and the modeler dialog closed, to allow the toolbox to refresh its
489-
contents.
486+
Your model can be run in various ways:
487+
488+
* You can run the whole model by clicking on |start| :sup:`Run Model...` from the toolbar
489+
or :menuselection:`Model -->` |start| :menuselection:`Run Model...`:
490+
when using the editor to execute a model, any non-default values will be saved in the inputs.
491+
This means that executing the model at a later time from the editor
492+
will have the dialog prefilled with those values on any subsequent run.
493+
* You can select elements of the model and run only that subset of the model:
494+
press the |runSelected| :guilabel:`Run Selected Steps...` option
495+
from the :menuselection:`Models -->` menu or from the contextual menu of a selected algorithm.
496+
The initial state will be taken from any previous executions of the model through the editor,
497+
so results from previous steps in the model are available for the selected steps.
498+
This makes it possible to fix parts of a large model,
499+
without having to constantly run the entire model to test.
500+
Especially useful when earlier steps in the model are time consuming.
501+
* You can run a subset of the model, starting from a specific algorithm:
502+
right-click the algorithm and select |start| :guilabel:`Run from Here...`.
503+
Likewise, values are taken from previous executions.
504+
* In order to use the algorithm from the Processing Toolbox, it has to be saved
505+
and the modeler dialog closed, to allow the toolbox to refresh its contents.
490506

491507

492508
Documenting your model
@@ -695,6 +711,8 @@ it.
695711
:width: 1.5em
696712
.. |redo| image:: /static/common/mActionRedo.png
697713
:width: 1.5em
714+
.. |runSelected| image:: /static/common/mActionRunSelected.png
715+
:width: 1.5em
698716
.. |saveAsPDF| image:: /static/common/mActionSaveAsPDF.png
699717
:width: 1.5em
700718
.. |saveAsPython| image:: /static/common/mActionSaveAsPython.png

static/common/mActionRunSelected.png

606 Bytes
Loading

substitutions.txt

+2
Original file line numberDiff line numberDiff line change
@@ -1050,6 +1050,8 @@
10501050
:width: 1.5em
10511051
.. |runConsole| image:: /static/common/iconRunConsole.png
10521052
:width: 1.5em
1053+
.. |runSelected| image:: /static/common/mActionRunSelected.png
1054+
:width: 1.5em
10531055
.. |saga| image:: /static/common/providerSaga.png
10541056
:width: 1.5em
10551057
.. |saveAsPDF| image:: /static/common/mActionSaveAsPDF.png

0 commit comments

Comments
 (0)