Skip to content

Commit

Permalink
Fix docs formatting for HOOK_WORKFLOW
Browse files Browse the repository at this point in the history 
missing indendation caused the section header and frame to
be lost
  • Loading branch information
@berland @markusdregi
berland authored and markusdregi committed Feb 5, 2019
1 parent 32b0797 commit 2f7ede5
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 62 deletions.
62 changes: 33 additions & 29 deletions docs/rst/manual/keywords/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2011,35 +2011,39 @@ Keywords related to plotting
.. _hook_workflow:
.. topic:: HOOK_WORKFLOW

With the keyword :code:`HOOK_WORKFLOW` you can configure workflow 'hooks';
meaning workflows which will be run automatically at certain points during ERTs
execution. Currently there are four points in ERTs flow of execution where you
can hook in a workflow, before the simulations start, :code:`PRE_SIMULATION`;
after all the simulations have completed :code:`POST_SIMULATION`; before the
update step, :code:`PRE_UPDATE` and after the update step, :code:`POST_UPDATE`.
The :code:`POST_SIMULATION` hook is typically used to trigger QC workflows:

::

HOOK_WORKFLOW initWFLOW PRE_SIMULATION
HOOK_WORKFLOW preUpdateWFLOW PRE_UPDATE
HOOK_WORKFLOW postUpdateWFLOW POST_UPDATE
HOOK_WORKFLOW QC_WFLOW1 POST_SIMULATION
HOOK_WORKFLOW QC_WFLOW2 POST_SIMULATION


In this example the workflow :code:`initWFLOW` will run after all the simulation
directories have been created, just before the forward model is submitted to the
queue. The workflow :code:`preUpdateWFLOW` will be run before the update step
and :code:`postUpdateWFLOW` will be run after the update step. When all the
simulations are complete the two workflows :code:`QC_WFLOW1` and
:code:`QC_WFLOW2` will be run.

Observe that the workflows being 'hooked in' with the :code:`HOOK_WORKFLOW` must
be loaded with the :code:`LOAD_WORKFLOW` keyword.

Currently, :code:`PRE_UPDATE` and :code:`POST_UPDATE` are only available from
python.
With the keyword :code:`HOOK_WORKFLOW` you can configure workflow
'hooks'; meaning workflows which will be run automatically at
certain points during ERTs execution. Currently there are four
points in ERTs flow of execution where you can hook in a workflow,
before the simulations start, :code:`PRE_SIMULATION`; after all
the simulations have completed :code:`POST_SIMULATION`; before the
update step, :code:`PRE_UPDATE` and after the update step,
:code:`POST_UPDATE`. The :code:`POST_SIMULATION` hook is
typically used to trigger QC workflows:

::

HOOK_WORKFLOW initWFLOW PRE_SIMULATION
HOOK_WORKFLOW preUpdateWFLOW PRE_UPDATE
HOOK_WORKFLOW postUpdateWFLOW POST_UPDATE
HOOK_WORKFLOW QC_WFLOW1 POST_SIMULATION
HOOK_WORKFLOW QC_WFLOW2 POST_SIMULATION


In this example the workflow :code:`initWFLOW` will run after all
the simulation directories have been created, just before the
forward model is submitted to the queue. The workflow
:code:`preUpdateWFLOW` will be run before the update step and
:code:`postUpdateWFLOW` will be run after the update step. When
all the simulations are complete the two workflows
:code:`QC_WFLOW1` and :code:`QC_WFLOW2` will be run.

Observe that the workflows being 'hooked in' with the
:code:`HOOK_WORKFLOW` must be loaded with the
:code:`LOAD_WORKFLOW` keyword.

Currently, :code:`PRE_UPDATE` and :code:`POST_UPDATE` are only
available from python.

Manipulating the Unix environment
---------------------------------
Expand Down
66 changes: 33 additions & 33 deletions docs/user/keywords/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1700,39 +1700,39 @@ Keywords related to plotting
.. _hook_workflow:
.. topic:: HOOK_WORKFLOW

With the keyword :code:`HOOK_WORKFLOW` you can configure workflow
'hooks'; meaning workflows which will be run automatically at certain
points during ERTs execution. Currently there are four points in ERTs
flow of execution where you can hook in a workflow, before
the simulations start, :code:`PRE_SIMULATION`; after all the
simulations have completed :code:`POST_SIMULATION`;
before the update step, :code:`PRE_UPDATE` and after the update step, :code:`POST_UPDATE`. The
:code:`POST_SIMULATION` hook is typically used to trigger QC
workflows:

::

HOOK_WORKFLOW initWFLOW PRE_SIMULATION
HOOK_WORKFLOW preUpdateWFLOW PRE_UPDATE
HOOK_WORKFLOW postUpdateWFLOW POST_UPDATE
HOOK_WORKFLOW QC_WFLOW1 POST_SIMULATION
HOOK_WORKFLOW QC_WFLOW2 POST_SIMULATION


In this example the workflow :code:`initWFLOW` will run after all
the simulation directories have been created, just before the forward
model is submitted to the queue. The workflow :code:`preUpdateWFLOW` will be run before the
update step and :code:`postUpdateWFLOW` will be run after the
update step. When all the simulations are complete
the two workflows :code:`QC_WFLOW1` and :code:`QC_WFLOW2` will be
run.

Observe that the workflows being 'hooked in' with the
:code:`HOOK_WORKFLOW` must be loaded with the :code:`LOAD_WORKFLOW`
keyword.

Currently, :code:`PRE_UPDATE` and :code:`POST_UPDATE` are only
available from python.
With the keyword :code:`HOOK_WORKFLOW` you can configure workflow
'hooks'; meaning workflows which will be run automatically at
certain points during ERTs execution. Currently there are four
points in ERTs flow of execution where you can hook in a workflow,
before the simulations start, :code:`PRE_SIMULATION`; after all
the simulations have completed :code:`POST_SIMULATION`; before the
update step, :code:`PRE_UPDATE` and after the update step,
:code:`POST_UPDATE`. The :code:`POST_SIMULATION` hook is typically
used to trigger QC workflows:

::

HOOK_WORKFLOW initWFLOW PRE_SIMULATION
HOOK_WORKFLOW preUpdateWFLOW PRE_UPDATE
HOOK_WORKFLOW postUpdateWFLOW POST_UPDATE
HOOK_WORKFLOW QC_WFLOW1 POST_SIMULATION
HOOK_WORKFLOW QC_WFLOW2 POST_SIMULATION


In this example the workflow :code:`initWFLOW` will run after all
the simulation directories have been created, just before the
forward model is submitted to the queue. The workflow
:code:`preUpdateWFLOW` will be run before the update step and
:code:`postUpdateWFLOW` will be run after the update step. When
all the simulations are complete the two workflows
:code:`QC_WFLOW1` and :code:`QC_WFLOW2` will be run.

Observe that the workflows being 'hooked in' with the
:code:`HOOK_WORKFLOW` must be loaded with the :code:`LOAD_WORKFLOW`
keyword.

Currently, :code:`PRE_UPDATE` and :code:`POST_UPDATE` are only
available from python.

Manipulating the Unix environment
---------------------------------
Expand Down

0 comments on commit 2f7ede5

Please sign in to comment.