Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change [[dependencies]] => [[graph]] #51

Merged
merged 2 commits into from
Aug 6, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/appendices/remote-job-management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ and a local task views a remote job log then polls and kills the remote jobs.

# suite.rc
[scheduling]
[[dependencies]]
graph = "delayer => master & REMOTES"
[[graph]]
R1 = "delayer => master & REMOTES"
[runtime]
[[REMOTES]]
script = "sleep 30"
Expand Down
17 changes: 3 additions & 14 deletions src/appendices/suiterc-config-ref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1150,7 +1150,7 @@ tasks, may be required.
- *default*: (none)


[scheduling] ``->`` [[dependencies]]
[scheduling] ``->`` [[graph]]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The suite dependency graph is defined under this section. You can plot
Expand All @@ -1161,7 +1161,7 @@ also :ref:`ConfiguringScheduling`.

.. _GraphDescrip:

[scheduling] ``->`` [[dependencies]] ``->`` \_\_RECURRENCE\_\_
[scheduling] ``->`` [[graph]] ``->`` \_\_RECURRENCE\_\_
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

The ``__RECURRENCE__`` defines the sequence of cycle points for
Expand All @@ -1185,7 +1185,7 @@ follow; see also :ref:`ConfiguringScheduling` and :ref:`TriggerTypes`.

.. code-block:: cylc

graph = """
PT1H = """
foo => bar => baz & waz # baz and waz both trigger off bar
foo[-P1D-PT6H] => bar # bar triggers off foo[-P1D-PT6H]
baz:out1 => faz # faz triggers off a message output of baz
Expand All @@ -1204,17 +1204,6 @@ follow; see also :ref:`ConfiguringScheduling` and :ref:`TriggerTypes`.
- *default*: (none)


[scheduling] ``->`` [[dependencies]] ``->`` graph
"""""""""""""""""""""""""""""""""""""""""""""""""

Implies a non-cycling suite, and same as ``R1 = ...``. The value should be a
dependency graph. See also :ref:`GraphDescrip` above and
:ref:`ConfiguringScheduling`, for graph string syntax.

- *type*: string
- *example*: (see :ref:`GraphDescrip` above)


[runtime]
---------

Expand Down
10 changes: 5 additions & 5 deletions src/external-triggers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ cycle point value by one hour:
initial cycle point = 2018-01-01
[[xtriggers]]
clock_1 = wall_clock(offset=PT1H):PT10S
[[dependencies]]
[[graph]]
P1D = "@clock_1 => foo"
[runtime]
[[foo]]
Expand All @@ -102,7 +102,7 @@ the ``[xtriggers]`` section:

[scheduling]
initial cycle point = 2018-01-01
[[dependencies]]
[[graph]]
# zero-offset clock trigger:
P1D = "@wall_clock => foo"
[runtime]
Expand Down Expand Up @@ -318,7 +318,7 @@ Here's an example echo trigger suite:
initial cycle point = now
[[xtriggers]]
echo_1 = echo(hello, 99, qux=True, point=%(point)s, foo=10)
[[dependencies]]
[[graph]]
PT1H = "@echo_1 => foo"
[runtime]
[[foo]]
Expand Down Expand Up @@ -434,7 +434,7 @@ scheduling section:
initial cycle point = 1
[[special tasks]]
external-trigger = get-data("new sat X data avail")
[[dependencies]]
[[graph]]
P1 = get-data => conv-data => products

Then, each time a new dataset arrives the external detection system should
Expand Down Expand Up @@ -474,7 +474,7 @@ message:
final cycle point = 20150126T00
[[special tasks]]
external-trigger = get-data("data arrived for $CYLC_TASK_CYCLE_POINT")
[[dependencies]]
[[graph]]
T00 = init-process => get-data => post-process

Once the variable-length waiting is finished, an external detection system
Expand Down
23 changes: 10 additions & 13 deletions src/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,13 @@ Glossary
graph
The graph of a :term:`suite<Cylc suite>` refers to the
:term:`graph strings<graph string>` contained within the
``[scheduling][dependencies]`` section. For example the following is,
``[scheduling][graph]`` section. For example the following is,
collectively, a graph:

.. code-block:: cylc

[P1D]
graph = foo => bar
[PT12H]
graph = baz
P1D = foo => bar
PT12H = baz

.. digraph:: example
:align: center
Expand Down Expand Up @@ -285,12 +283,11 @@ Glossary
[scheduling]
initial cycle point = 1
cycling mode = integer
[[dependencies]]
[[[P1]]]
graph = """
foo => bar => baz
bar[-P1] => bar
"""
[[graph]]
P1 = """
foo => bar => baz
bar[-P1] => bar
"""

.. digraph:: example
:align: center
Expand Down Expand Up @@ -641,8 +638,8 @@ Glossary
[[parameters]]
foo = 1..3
[scheduling]
[[dependencies]]
graph = bar<foo> => baz<foo>
[[graph]]
R1 = bar<foo> => baz<foo>

.. minicylc::
:theme: none
Expand Down
18 changes: 9 additions & 9 deletions src/running-suites.rst
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ workflow by coding tasks that run the ``cylc checkpoint`` command:
.. code-block:: cylc

[scheduling]
[[dependencies]]
[[graph]]
PT6H = "pre => model => post => checkpointer"
[runtime]
# ...
Expand Down Expand Up @@ -1227,7 +1227,7 @@ a remote suite called ``other.suite``:
.. code-block:: cylc

[scheduling]
[[dependencies]]
[[graph]]
T00, T12 = "my-foo<other.suite::foo> => bar"

Local task ``my-foo`` will poll for the success of ``foo``
Expand All @@ -1236,7 +1236,7 @@ or if it succeeds. Other task states can also be polled:

.. code-block:: cylc

graph = "my-foo<other.suite::foo:fail> => bar"
T00, T12 = "my-foo<other.suite::foo:fail> => bar"

The default polling parameters (e.g. maximum number of polls and the interval
between them) are printed by ``cylc suite-state --help`` and can be
Expand All @@ -1245,7 +1245,7 @@ configured if necessary under the local polling task runtime section:
.. code-block:: cylc

[scheduling]
[[ dependencies]]
[[graph]]
T00,T12 = "my-foo<other.suite::foo> => bar"
[runtime]
[[my-foo]]
Expand Down Expand Up @@ -1283,7 +1283,7 @@ at ``3,9,15,21``:
.. code-block:: cylc

[scheduling]
[[dependencies]]
[[graph]]
T03,T09,T15,T21 = "my-dog<other.suite::dog>"
T00,T06,T12,T18 = "my-dog[-PT3H] => cat"

Expand All @@ -1307,8 +1307,8 @@ command interrogates the suite run database, not the suite server program.
.. code-block:: cylc

[scheduling]
[[dependencies]]
graph = "poller<other-suite::foo:succeed>:fail => another-task"
[[graph]]
R1 = "poller<other-suite::foo:succeed>:fail => another-task"
[runtime]
[[my-foo]]
[[[suite state polling]]]
Expand Down Expand Up @@ -1340,8 +1340,8 @@ cylc-7.2.0) by a small suite that runs two 30-second dummy tasks
[scheduling]
initial cycle point = 2017-01-01T00Z
final cycle point = 2017-01-01T00Z
[[dependencies]]
graph = "foo => bar"
[[graph]]
R1 = "foo => bar"
[runtime]
[[foo]]
script = sleep 30; /bin/false
Expand Down
Loading