Fix Tutorials (#2633)

Fix tutorials * Update .gitignore * Fix tutorials Co-authored-by: Oliver Sanders <[email protected]>
metomi · Oct 26, 2022 · 861b8ac · 861b8ac
1 parent 58dce23
commit 861b8ac
Show file tree

Hide file tree

Showing 17 changed files with 45 additions and 41 deletions.
diff --git a/.gitignore b/.gitignore
@@ -15,3 +15,4 @@ htmlcov/
 *.egg-info
 .vscode/
 .pytest_cache/
+node_modules/
diff --git a/etc/tutorial/consolidation-tutorial/etc b/etc/tutorial/consolidation-tutorial/etc
@@ -0,0 +1 @@
+../cylc-forecasting-suite/etc/
diff --git a/etc/tutorial/consolidation-tutorial/suite.rc b/etc/tutorial/consolidation-tutorial/suite.rc
@@ -8,7 +8,7 @@
         [[[PT3H]]]
             # Repeat every three hours starting at the initial cycle point.
             graph = """
-                get_observations_belmullet => consolidate_observations
+                get_observations_aldergrove => consolidate_observations
                 get_observations_camborne => consolidate_observations
                 get_observations_heathrow => consolidate_observations
                 get_observations_shetland => consolidate_observations
@@ -31,10 +31,10 @@
                 forecast[-PT6H] => forecast
             """
 [runtime]
-    [[get_observations_belmullet]]
+    [[get_observations_aldergrove]]
         script = get-observations
         [[[environment]]]
-            SITE_ID = 3976
+            SITE_ID = 3917
             API_KEY = DATAPOINT_API_KEY
     [[get_observations_camborne]]
         script = get-observations

diff --git a/...orecasting-suite/etc/met-office-sites.dat → ...orecasting-suite/etc/met-office-sites.dat b/...orecasting-suite/etc/met-office-sites.dat → ...orecasting-suite/etc/met-office-sites.dat
diff --git a/etc/tutorial/cylc-forecasting-suite/suite.rc b/etc/tutorial/cylc-forecasting-suite/suite.rc
@@ -3,7 +3,7 @@
     UTC mode = True
     [[parameters]]
         # A list of the weather stations we will be fetching observations from.
-        station = camborne, heathrow, shetland, belmullet
+        station = camborne, heathrow, shetland, aldergrove
         # A list of the sites we will be generating forecasts for.
         site = exeter
 
@@ -52,9 +52,9 @@
             # To use archived data comment this line out.
             API_KEY = DATAPOINT_API_KEY
 
-    [[get_observations<station=belmullet>]]
+    [[get_observations<station=aldergrove>]]
         [[[environment]]]
-            SITE_ID = 3976
+            SITE_ID = 3917
     [[get_observations<station=camborne>]]
         [[[environment]]]
             SITE_ID = 3808

diff --git a/etc/tutorial/rose-suite-tutorial/etc b/etc/tutorial/rose-suite-tutorial/etc
@@ -0,0 +1 @@
+../cylc-forecasting-suite/etc/
diff --git a/etc/tutorial/rose-weather-forecasting-suite/etc b/etc/tutorial/rose-weather-forecasting-suite/etc
@@ -0,0 +1 @@
+../cylc-forecasting-suite/etc/
diff --git a/etc/tutorial/runtime-introduction/suite.rc b/etc/tutorial/runtime-introduction/suite.rc
@@ -9,7 +9,7 @@
                 get_observations_camborne => consolidate_observations
                 get_observations_heathrow => consolidate_observations
                 get_observations_shetland => consolidate_observations
-                get_observations_belmullet => consolidate_observations
+                get_observations_aldergrove => consolidate_observations
             """
         [[[T06/PT6H]]]
             graph = """
@@ -25,7 +25,7 @@
             """
 
 [runtime]
-    [[get_observations_belmullet]]
+    [[get_observations_aldergrove]]
         script = get-observations
 
     [[get_observations_camborne]]

diff --git a/etc/tutorial/runtime-tutorial/etc b/etc/tutorial/runtime-tutorial/etc
@@ -0,0 +1 @@
+../cylc-forecasting-suite/etc/
diff --git a/etc/tutorial/runtime-tutorial/suite.rc b/etc/tutorial/runtime-tutorial/suite.rc
@@ -8,7 +8,7 @@
         [[[PT3H]]]
             # Repeat every three hours starting at the initial cycle point.
             graph = """
-                get_observations_belmullet => consolidate_observations
+                get_observations_aldergrove => consolidate_observations
                 get_observations_camborne => consolidate_observations
                 get_observations_heathrow => consolidate_observations
                 get_observations_shetland => consolidate_observations

diff --git a/sphinx/tutorial/cylc/runtime/configuration-consolidation/families.rst b/sphinx/tutorial/cylc/runtime/configuration-consolidation/families.rst
@@ -103,10 +103,10 @@ Runtime
            inherit = GET_OBSERVATIONS
            [[[environment]]]
                SITE_ID = 3005
-       [[get_observations_belmullet]]
+       [[get_observations_aldergrove]]
            inherit = GET_OBSERVATIONS
            [[[environment]]]
-               SITE_ID = 3976
+               SITE_ID = 3917
 
 
 Graphing
@@ -132,7 +132,7 @@ Graphing
    get_observations_heathrow => consolidate_observations
    get_observations_camborne => consolidate_observations
    get_observations_shetland => consolidate_observations
-   get_observations_belmullet => consolidate_observations
+   get_observations_aldergrove => consolidate_observations
 
 .. ifnotslides::
 

diff --git a/sphinx/tutorial/cylc/runtime/configuration-consolidation/index.rst b/sphinx/tutorial/cylc/runtime/configuration-consolidation/index.rst
@@ -33,10 +33,10 @@ Consolidating Configuration
               [[[environment]]]
                   SITE_ID = 3005
                   API_KEY = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
-          [[get_observations_belmullet]]
+          [[get_observations_aldergrove]]
               script = get-observations
               [[[environment]]]
-                  SITE_ID = 3976
+                  SITE_ID = 3917
                   API_KEY = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
 
 .. ifnotslides::
@@ -68,7 +68,7 @@ Consolidating Configuration
           [[dependencies]]
               [[[T00/PT3H]]]
                   graph = """
-                      get_observations_belmullet => consolidate_observations
+                      get_observations_aldergrove => consolidate_observations
                       get_observations_camborne => consolidate_observations
                       get_observations_heathrow => consolidate_observations
                       get_observations_shetland => consolidate_observations

diff --git a/sphinx/tutorial/cylc/runtime/configuration-consolidation/jinja2.rst b/sphinx/tutorial/cylc/runtime/configuration-consolidation/jinja2.rst
@@ -78,7 +78,7 @@ define a dictionary of station and ID pairs:
 
 .. code-block:: css+jinja
 
-   {% set stations = {'belmullet': 3976,
+   {% set stations = {'aldergrove': 3917,
                       'camborne': 3808,
                       'heathrow': 3772,
                       'shetland': 3005} %}
@@ -97,7 +97,7 @@ After processing, this would result in:
 
 .. code-block:: none
 
-       belmullet
+       aldergrove
        camborne
        heathrow
        shetland
@@ -116,7 +116,7 @@ This would result in:
 
 .. code-block:: none
 
-       belmullet - 3976
+       aldergrove - 3917
        camborne - 3808
        heathrow - 3772
        shetland - 3005
@@ -132,7 +132,7 @@ This would result in:
 
    #!Jinja2
 
-   {% set stations = {'belmullet': 3976,
+   {% set stations = {'aldergrove': 3917,
                       'camborne': 3808,
                       'heathrow': 3772,
                       'shetland': 3005} %}
@@ -217,10 +217,10 @@ This would result in:
                      SITE_ID = 3005
          -            API_KEY = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
          +            API_KEY = {{ API_KEY }}
-              [[get_observations_belmullet]]
+              [[get_observations_aldergrove]]
                   script = get-observations
                   [[[environment]]]
-                      SITE_ID = 3976
+                      SITE_ID = 3917
          -            API_KEY = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
          +            API_KEY = {{ API_KEY }}
              [[get_rainfall]]

diff --git a/sphinx/tutorial/cylc/runtime/configuration-consolidation/parameters.rst b/sphinx/tutorial/cylc/runtime/configuration-consolidation/parameters.rst
@@ -167,9 +167,9 @@ Parameters can be either words or integers:
            [[[environment]]]
                API_KEY = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
 
-       [[get_observations<station=belmullet>]]
+       [[get_observations<station=aldergrove>]]
            [[[environment]]]
-               SITE_ID = 3976
+               SITE_ID = 3917
        [[get_observations<station=camborne>]]
            [[[environment]]]
                SITE_ID = 3808
@@ -214,7 +214,7 @@ Parameters can be either words or integers:
           [cylc]
               UTC mode = True
          +    [[parameters]]
-         +        station = belmullet, camborne, heathrow, shetland
+         +        station = aldergrove, camborne, heathrow, shetland
 
       Remove the four ``get_observations`` tasks and insert the following code
       in their place:
@@ -248,7 +248,7 @@ Parameters can be either words or integers:
 
          The relevant IDs are:
 
-         * Belmullet - ``3976``
+         * Aldergrove - ``3917``
          * Camborne - ``3808``
          * Heathrow - ``3772``
          * Shetland - ``3005``
@@ -257,9 +257,9 @@ Parameters can be either words or integers:
 
          .. code-block:: cylc
 
-            [[get_observations<station=belmullet>]]
+            [[get_observations<station=aldergrove>]]
                 [[[environment]]]
-                    SITE_ID = 3976
+                    SITE_ID = 3917
             [[get_observations<station=camborne>]]
                 [[[environment]]]
                     SITE_ID = 3808
@@ -286,7 +286,7 @@ Parameters can be either words or integers:
           [[[PT3H]]]
               # Repeat every three hours starting at the initial cycle point.
               graph = """
-         -        get_observations_belmullet => consolidate_observations
+         -        get_observations_aldergrove => consolidate_observations
          -        get_observations_camborne => consolidate_observations
          -        get_observations_heathrow => consolidate_observations
          -        get_observations_shetland => consolidate_observations
@@ -327,7 +327,7 @@ Parameters can be either words or integers:
              [cylc]
                  UTC mode = True
                  [[parameters]]
-                     station = belmullet, camborne, heathrow, shetland
+                     station = aldergrove, camborne, heathrow, shetland
             +        site = exeter, edinburgh
 
          Next we parameterise the task in the graph:

diff --git a/sphinx/tutorial/cylc/runtime/runtime-configuration.rst b/sphinx/tutorial/cylc/runtime/runtime-configuration.rst
@@ -334,7 +334,7 @@ Start, Stop, Restart
 
       * Camborne - ``3808``
       * Shetland - ``3005``
-      * Belmullet - ``3976``
+      * Aldergrove - ``3917``
 
       .. spoiler:: Solution warning
 
@@ -356,10 +356,10 @@ Start, Stop, Restart
                     [[[environment]]]
                         SITE_ID = 3005
                         API_KEY = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
-                [[get_observations_belmullet]]
+                [[get_observations_aldergrove]]
                     script = get-observations
                     [[[environment]]]
-                        SITE_ID = 3976
+                        SITE_ID = 3917
                         API_KEY = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
 
       Check the ``suite.rc`` file is valid by running the command:
@@ -449,7 +449,7 @@ Start, Stop, Restart
             cylc gui runtime-tutorial &
 
          Run the suite either by:
-          
+
          * Pressing the play button in the Cylc GUI. Then, ensuring that
            "Cold Start" is selected within the dialogue window, pressing the
            "Start" button.
@@ -500,4 +500,3 @@ Start, Stop, Restart
            i.e. the final cycle point.
          * ``task-name`` - set this to "forecast".
          * ``submission-number`` - set this to "01".
-
diff --git a/sphinx/tutorial/cylc/scheduling/datetime-cycling.rst b/sphinx/tutorial/cylc/scheduling/datetime-cycling.rst
@@ -317,7 +317,7 @@ Putting It All Together
    build a picture of the current weather. Our dummy weather forecast
    will get wind observations from four weather stations:
 
-   * Belmullet
+   * Aldergrove
    * Camborne
    * Heathrow
    * Shetland
@@ -341,13 +341,13 @@ Putting It All Together
 
    size = "7,4"
 
-   get_observations_belmullet -> consolidate_observations
+   get_observations_aldergrove -> consolidate_observations
    get_observations_camborne -> consolidate_observations
    get_observations_heathrow -> consolidate_observations
    get_observations_shetland -> consolidate_observations
 
    hidden [style="invis"]
-   get_observations_belmullet -> hidden [style="invis"]
+   get_observations_aldergrove -> hidden [style="invis"]
    get_observations_camborne -> hidden [style="invis"]
    hidden -> consolidate_observations [style="invis"]
 
@@ -532,7 +532,7 @@ Putting It All Together
                [[dependencies]]
                    [[[PT3H]]]
                        graph = """
-                           get_observations_belmullet => consolidate_observations
+                           get_observations_aldergrove => consolidate_observations
                            get_observations_camborne => consolidate_observations
                            get_observations_heathrow => consolidate_observations
                            get_observations_shetland => consolidate_observations

diff --git a/sphinx/tutorial/rose/suites.rst b/sphinx/tutorial/rose/suites.rst
@@ -334,7 +334,7 @@ See the :ref:`Cheat Sheet` for more information.
       .. code-block:: rose
 
          [jinja2:suite.rc]
-         station="camborne", "heathrow", "shetland", "belmullet"
+         station="camborne", "heathrow", "shetland", "aldergrove"
 
          [env]
          RESOLUTION=0.2
@@ -411,7 +411,7 @@ See the :ref:`Cheat Sheet` for more information.
               UTC mode = True
               [[parameters]]
                   # A list of the weather stations we will be fetching observations from.
-         -        station = camborne, heathrow, shetland, belmullet
+         -        station = camborne, heathrow, shetland, aldergrove
          +        station = {{ station | join(", ") }}
                   # A list of the sites we will be generating forecasts for.
                   site = exeter
@@ -719,6 +719,6 @@ Rose Bush
       to least recent. Near the top you should see an entry for the
       ``forecast`` task. On the right-hand side of the screen click
       :guilabel:`job-map.html`.
-      
+
       As this file has a ``.html`` extension Rose Bush will render it.
       The raw text would be displayed otherwise.