Skip to content

Commit cd6ef6a

Browse files
authored
Merge pull request #564 from wxtim/20221028T1245--master--added_a_note_to_explain_hour_placeholder_in_icpnext_
added a note to explain hour placeholder in icp = next (T-??)
2 parents d5d6cc8 + df676cf commit cd6ef6a

File tree

2 files changed

+23
-18
lines changed

2 files changed

+23
-18
lines changed

src/dictionaries/proper_nouns

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,14 @@ Posix
3030
Protobuf
3131
Pympler
3232
Pyro
33+
pyproject
3334
rsync
3435
sge
3536
slurm
3637
Slurm
3738
sqlite
3839
svn
40+
toml
3941
Trac
4042
Tui
4143
Vuex

src/user-guide/writing-workflows/scheduling.rst

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -537,6 +537,10 @@ A list of times, separated by semicolons, can be provided, e.g.
537537
brackets, and if more than one is given, the major time unit in each (hours
538538
or minutes) should be of the same type.
539539

540+
.. note::
541+
542+
``T-00`` means every hour, on the hour. The ``-`` is a placeholder for the hours column.
543+
540544
If an offset from the specified datetime is required, this should be
541545
of the form ``previous(Thh:mm) +/- PxTy`` as is used
542546
for determining cycle periods, e.g.
@@ -574,21 +578,20 @@ Note that day-of-week should always be specified when using weeks. If a time
574578
is not included, the calculation of the next or previous corresponding
575579
point will be done from midnight of the current day.
576580

577-
.. table:: Relative initial cycle point examples for ``now = 2018-03-14T15:12Z``
581+
.. csv-table:: Relative initial cycle point examples for ``now = 2018-03-14T15:12Z``
582+
using ISO8601 truncated dates.
583+
:widths: auto
578584

579-
==================================== ==================
580-
Syntax Interpretation
581-
==================================== ==================
582-
``next(-00)`` 2100-01-01T00:00Z
583-
``previous(--01)`` 2018-01-01T00:00Z
584-
``next(---01)`` 2018-04-01T00:00Z
585-
``previous(--1225)`` 2017-12-25T00:00Z
586-
``next(-2006)`` 2020-06-01T00:00Z
587-
``previous(-W101)`` 2018-03-05T00:00Z
588-
``next(-W-1; -W-3; -W-5)`` 2018-03-14T00:00Z
589-
``next(-001; -091; -181; -271)`` 2018-04-01T00:00Z
590-
``previous(-365T12Z)`` 2017-12-31T12:00Z
591-
==================================== ==================
585+
Syntax, Description, Interpretation
586+
``next(-00)``, Any century; next year 00, 2100-01-01
587+
``previous(--01)``, Any year; next month 01, 2018-01-01
588+
``next(---01)``, Any year; any month; next 1st of month, 2018-04-01
589+
``previous(--1225)``, Any year; previous Dec 25, 2017-12-25
590+
``next(-2006)``, Any century; next June in a year ending 20, 2020-06-01
591+
``previous(-W101)``, Any century; previous week 10 day 1, 2018-03-05
592+
``next(-W-1; -W-3; -W-5)``, "Any year; any week; next day 1, 3 or 5", 2018-03-14
593+
``next(-001; -091; -181; -271)``, "Any year; day 1, 91, 181 or 271", 2018-04-01
594+
``previous(-365T12Z)``, Any year; previous day 356 at 12Z, 2017-12-31T12:00Z
592595

593596

594597
The Environment Variable CYLC\_WORKFLOW\_INITIAL\_CYCLE\_POINT
@@ -2017,7 +2020,7 @@ lowest-valued point with :term:`active` or :term:`incomplete` tasks present.
20172020

20182021
The runahead limit can be set with :cylc:conf:`[scheduling]runahead limit`,
20192022
to an integer interval (for datetime or integer cycling workflows) or to
2020-
a datetime interval (datetime cycling only).
2023+
a datetime interval (datetime cycling only).
20212024

20222025
The integer format ``Pn`` is an interval that spans ``n+1`` consecutive cycle
20232026
points, regardless of how the cycle point values increment from one point to
@@ -2041,8 +2044,8 @@ finishes and allows the runahead limit to move on:
20412044
[[graph]]
20422045
P2 = foo # cycle points 1, 3, 5, 7, 9, ...
20432046
2044-
The active cycle points in this workflow, at some point during the run,
2045-
might be ``29, 31, 33, 35``, for example.
2047+
The active cycle points in this workflow, at some point during the run,
2048+
might be ``29, 31, 33, 35``, for example.
20462049

20472050
.. code-block:: cylc
20482051
@@ -2074,7 +2077,7 @@ they might be ``2060, 2061, 2062, 2063, 2064``.
20742077
.. note::
20752078

20762079
To restrict activity to a single cycle point at a time (just the base point)
2077-
use a null runahead interval: ``P0`` or (e.g.) ``PT0H``.
2080+
use a null runahead interval: ``P0`` or (e.g.) ``PT0H``.
20782081

20792082

20802083
.. note::

0 commit comments

Comments
 (0)