Consolidating Configuration§

Weather Forecasting Suite

[runtime]
    [[get_observations_heathrow]]
        script = get-observations
        [[[environment]]]
            SITE_ID = 3772
            API_KEY = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    [[get_observations_camborne]]
        script = get-observations
        [[[environment]]]
            SITE_ID = 3808
            API_KEY = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    [[get_observations_shetland]]
        script = get-observations
        [[[environment]]]
            SITE_ID = 3005
            API_KEY = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    [[get_observations_aldergrove]]
        script = get-observations
        [[[environment]]]
            SITE_ID = 3917
            API_KEY = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Weather Forecasting Suite

Repetition

script
API_KEY

Weather Forecasting Suite

[scheduling]
    [[dependencies]]
        [[[T00/PT3H]]]
            graph = """
                get_observations_aldergrove => consolidate_observations
                get_observations_camborne => consolidate_observations
                get_observations_heathrow => consolidate_observations
                get_observations_shetland => consolidate_observations
            """

Consolidating Configuration§

Cylc offers three ways of consolidating configurations to help improve the structure of a suite and avoid duplication.

The `cylc get-config` Command§

cylc get-config <path> --sparse

# Print the contents of the [scheduling] section.
cylc get-config <path> --sparse -i '[scheduling]'
# Print the contents of the get_observations_heathrow task.
cylc get-config <path> --sparse -i '[runtime][get_observations_heathrow]'
# Print the value of the script setting in the get_observations_heathrow task
cylc get-config <path> --sparse -i '[runtime][get_observations_heathrow]script'

The `cylc get-config` Command§

Note that cylc get-config doesn’t expand families or parameterisations in the graph. Use cylc graph to visualise these.

The Three Approaches§

Which Approach To Use§

As a rule of thumb each method works best for:

Families: Collecting tasks into broad groups.
Jinja2: Configuration settings which apply to the entire suite.
Parameterisation: Tasks which are similar.

Which Approach To Use§

Next section: Rose Tutorial