Resolves #87: Fix Cylc tutorial

.gitignore

@@ -1,4 +1,5 @@
 .idea
 .ipynb_checkpoints
 */~*
+*.swp
 ~*

tutorials/tut02/example-workflow/README.md

@@ -0,0 +1,109 @@
+# Running the workflow
+
+## To run the workflow
+
+`cylc validate .`
+`cylc install .`
+`cylc play example-workflow`
+
+## To stop the workflow (if failed/still running)
+
+`cylc stop example-workflow`
+
+## To clean out the workflow working directory
+
+`cylc clean example-workflow`
+
+This can be required before re-running.
+
+## Working directory
+
+When Cylc runs the workflow it has a working directory where the workflow is run.
+This is referenced in the `flow.cylc` file with the environment variable
+`$CYLC_WORKFLOW_RUN_DIR`.
+
+By default this will be under:
+
+```
+$HOME/cylc-run/<workflow_name>/runN/
+```
+
+### Stopping a workflow that is running
+
+Note: In our example workflow, named 'example-workflow', you would change the value of '<WORKFLOW>' to
+'example-workflow' in the following commands.
+
+If you need to stop the workflow you can use:
+
+```
+cylc stop '<WORKFLOW>'
+```
+
+The `cylc stop` command may not stop the workflow immediately - because it will wait for submitted
+and running tasks to complete. 
+
+To kill the submitted and running tasks before stopping the workflow, use:
+
+```
+cylc stop --kill '<WORKFLOW>'
+```
+
+To stop the workflow regardless of submitted and running tasks (shut down immediately, leave active tasks alone), use:
+
+```
+cylc stop --now '<WORKFLOW>'
+```
+
+### Working directory for the example workflow
+
+In the case of the `example-workflow` the working directory will be:
+
+```
+$HOME/cylc-run/example-workflow/runN/
+```
+
+The example workflow uses this as the common location for all scripts and the outputs
+directory to be located in. 
+
+### Viewing the workflow graph of the workflow
+
+To view the workflow graph of your workflow _without_ running it, use:
+
+```
+cylc install
+cylc graph example-workflow
+```
+
+NOTE: `cylc install` only installs the workflow. This will not run the workflow until `cylc play` is run.
+
+
+### Viewing available platform options on the system
+
+```
+cylc config --platforms
+```
+
+This will list the options you have available that you can use in your `flow.cylc` file - such as running on the local system, or on lotus, e.g.:
+
+```
+$ cylc config --platforms
+[platforms]
+    [[localhost]]
+        install target = localhost
+        copyable environment variables = FCM_VERSION
+        submission polling intervals = PT30M
+        execution polling intervals = PT30M
+        execution time limit polling intervals = PT5M, PT10M
+        clean job submission environment = True
+    [[lotus]]
+        install target = localhost
+        copyable environment variables = FCM_VERSION
+        submission polling intervals = PT30M
+        execution polling intervals = PT30M
+        execution time limit polling intervals = PT5M, PT10M
+        clean job submission environment = True
+        hosts = localhost
+        job runner = slurm
+        [[[meta]]]
+            description = LOTUS Slurm job
+```

tutorials/tut02/example-suite/suite.rc → tutorials/tut02/example-workflow/flow.cylc

@@ -1,24 +1,23 @@
-[cylc]
-    UTC mode = True # Ignore DST
-    [[parameters]]
-        counter = 1..20
+[task parameters]
+    counter = 1..20
 
 [scheduling]
-    [[dependencies]]
-        graph = """
+    [[graph]]
+        R1 = """
             initialise => step1
             step1 => batch<counter>
-            batch<counter> => finish"""
+            batch<counter> => finish
+        """
 
 [runtime]
     [[root]]
         # This is applied before every task
         pre-script="""set -eu"""
-        [[[job]]]
-            batch system = slurm
-            execution time limit = PT5M
+        execution time limit = PT5M
+        platform = lotus # See options via `cylc config --platforms`, e.g. `localhost`, `lotus`
         [[[directives]]]
-            --partition = workshop
+            --partition = debug
+            --qos = debug
             --account = workshop
             --time = 05:00
     [[initialise]]