Families§

Practical§

In this practical we will consolidate the configuration of the weather-forecasting suite from the previous section.

1. Create A New Suite.

   To make a new copy of the forecasting suite run the following commands:

   rose tutorial consolidation-tutorial
   cd ~/cylc-run/consolidation-tutorial
   

   Set the intial and final cycle points as you did in the previous tutorial.

2. Move Site-Wide Settings Into The root Family.

   The following three environment variables are used by multiple tasks:

   PYTHONPATH="$CYLC_SUITE_DEF_PATH/lib/python:$PYTHONPATH"
   RESOLUTION = 0.2
   DOMAIN = -12,48,5,61  # Do not change!
   

   Rather than manually adding them to each task individually we could put them in the root family, making them accessible to all tasks.

   Add a root section containing these three environment variables. Remove the variables from any other task’s environment sections:

    [runtime]
   +    [[root]]
   +        [[[environment]]]
   +            # Add the `python` directory to the PYTHONPATH.
   +            PYTHONPATH="$CYLC_SUITE_DEF_PATH/lib/python:$PYTHONPATH"
   +            # The dimensions of each grid cell in degrees.
   +            RESOLUTION = 0.2
   +            # The area to generate forecasts for (lng1, lat1, lng2, lat2).
   +            DOMAIN = -12,48,5,61  # Do not change!
   

    [[consolidate_observations]]
        script = consolidate-observations
   -    [[[environment]]]
   -        # Add the `python` directory to the PYTHONPATH.
   -        PYTHONPATH="$CYLC_SUITE_RUN_DIR/lib/python:$PYTHONPATH"
   -        # The dimensions of each grid cell in degrees.
   -        RESOLUTION = 0.2
   -        # The area to generate forecasts for (lng1, lat1, lng2, lat2).
   -        DOMAIN = -12,48,5,61  # Do not change!
   
    [[get_rainfall]]
        script = get-rainfall
        [[[environment]]]
            # The key required to get weather data from the DataPoint service.
            # To use archived data comment this line out.
            API_KEY = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
   -        # Add the `python` directory to the PYTHONPATH.
   -        PYTHONPATH="$CYLC_SUITE_RUN_DIR/lib/python:$PYTHONPATH"
   -        # The dimensions of each grid cell in degrees.
   -        RESOLUTION = 0.2
   -        # The area to generate forecasts for (lng1, lat1, lng2, lat2).
   -        DOMAIN = -12,48,5,61  # Do not change!
   
    [[forecast]]
        script = forecast 60 5  # Generate 5 forecasts at 60 minute intervals.
        [[[environment]]]
   -        # Add the `python` directory to the PYTHONPATH.
   -        PYTHONPATH="$CYLC_SUITE_RUN_DIR/lib/python:$PYTHONPATH"
   -        # The dimensions of each grid cell in degrees.
   -        RESOLUTION = 0.2
   -        # The area to generate forecasts for (lng1, lat1, lng2, lat2)
   -        DOMAIN = -12,48,5,61  # Do not change!
            # The path to the files containing wind data (the {variables} will
            # get substituted in the forecast script).
            WIND_FILE_TEMPLATE = $CYLC_SUITE_WORK_DIR/{cycle}/consolidate_observations/wind_{xy}.csv
            # List of cycle points to process wind data from.
            WIND_CYCLES = 0, -3, -6
   
            # The path to the rainfall file.
            RAINFALL_FILE = $CYLC_SUITE_WORK_DIR/$CYLC_TASK_CYCLE_POINT/get_rainfall/rainfall.csv
            # Create the html map file in the task's log directory.
            MAP_FILE = "${CYLC_TASK_LOG_ROOT}-map.html"
            # The path to the template file used to generate the html map.
            MAP_TEMPLATE = "$CYLC_SUITE_RUN_DIR/lib/template/map.html"
   
    [[post_process_exeter]]
        # Generate a forecast for Exeter 60 minutes into the future.
        script = post-process exeter 60
   -    [[[environment]]]
   -        # Add the `python` directory to the PYTHONPATH.
   -        PYTHONPATH="$CYLC_SUITE_RUN_DIR/lib/python:$PYTHONPATH"
   -        # The dimensions of each grid cell in degrees.
   -        RESOLUTION = 0.2
   -        # The area to generate forecasts for (lng1, lat1, lng2, lat2).
   -        DOMAIN = -12,48,5,61  # Do not change!
   

   To ensure that the environment variables are being inherited correctly by the tasks, inspect the [runtime] section using cylc get-config by running the following command:

   cylc get-config . --sparse -i "[runtime]"
   

   You should see the environment variables from the [root] section in the [environment] section for all tasks.

   Tip

   You may find it easier to open the output of this command in a text editor, e.g:

   cylc get-config . --sparse -i "[runtime]" | gvim -