Cylc Configuration Data Types
The Cylc configuration file format supports the following data types.
- absolute host list
A comma separated list of hostnames which does not contain any self references (i.e. does not contain localhost, 127.0.0.1, 0.0.0.0)
Examples:
foo
bar
baz
- boolean
A boolean in Python format
Examples:
True
False
- cycle point
An integer or date-time cycle point as appropriate.
Examples:
1
- An integer cycle point.2000-01-01T00:00Z
- A date-time cycle point.now
- The current date-time.next(T-00)
- The current date-time rounded up to the nearest whole hour.
See Also:
- cycle point format
An time format for date-time cycle points in
isodatetime
“print” or “parse” format. Seeisodatetime --help
for more information.Examples:
CCYYMM
-isodatetime
print format.%Y%m
-isodatetime
parse format.
- cycle point time zone
A time zone for date-time cycle points in ISO8601 format.
Examples:
Z
- UTC / GMT.+13
- UTC plus 13 hours.-0830
- UTC minus 8 hours and 30 minutes.
- cycle point with support for offsets
An integer or date-time cycle point, with optional offset(s).
Examples:
1
- An integer cycle point.1 +P5
- An integer cycle point with an offset (this evaluates as6
).+P5
- An integer cycle point offset. This offset is added to the initial cycle point2000-01-01T00:00Z
- A date-time cycle point.2000-02-29T00:00Z +P1D +P1M
- A date-time cycle point with offsets (this evaluates as2000-04-01T00:00Z
).
- float
A number in integer, decimal or exponential format
Examples:
1
1.1
1.1e11
- float list
A comma separated list of floats.
Examples:
1, 1.1, 1.1e11
- integer
An integer.
Examples:
1
2
3
- integer list
A comma separated list of integers.
Examples:
1, 2, 3
1..3
1..3, 7
- time interval
An ISO8601 duration.
Examples:
P1Y
- Every year.PT6H
- Every six hours.
See Also:
- time interval list
A comma separated list of time intervals. These can include multipliers.
Examples:
P1Y, P2Y, P3Y
- After 1, 2 and 3 years.PT1M, 2*PT1H, P1D
- After 1 minute, 1 hour, 1 hour and 1 day
See Also:
- parameter list
A comma separated list of Cylc parameter values. This can include strings, integers and integer ranges.
Examples:
foo, bar, baz
- List of string parameters.1, 2, 3
- List of integer parameters.1..3
- The same as 1, 2, 3.1..5..2
- The same as 1, 3, 5.1..5..2, 8
- Range and integers can be mixed.
See Also:
- integer range
An integer range specified by a minimum and maximum value.
Examples:
1..5
- The numbers 1 to 5 inclusive.
- spaceless list
A comma separated list of strings which cannot contain spaces.
Examples:
a, b, c
- string
Plain text.
Examples:
Hello World!
- list
A comma separated list of strings.
Examples:
a, b c, d
- xtrigger function signature
A function signature similar to how it would be written in Python.
<function>(<arg>, <kwarg>=<value>):<interval>
Examples:
mytrigger(42, cycle_point=%(point)):PT10S
- Run functionmytrigger
every 10 seconds.
See Also: