Introduction
The Rose User Guide pages are intended to be
dual-purpose - they are readable offline as well as the
basis for a training course.
This page documents some advice and a suggested
schedule for training users using this material.
Schedule
We suggest a 2 day format, composed of both
talks/seminars and desk work. On the morning of the
first day, there is a generic overview of Rose and
cylc, followed by some basic tutorials. The afternoon
of the first day is spent discussing metadata and the
Rosie subsystem. The second day is dedicated to suite
development (cylc) and system-specifics.
Here is an example schedule:
Pre-course preparation: Getting Started
Day 1:
Day 2:
- 0915 - 0945: Talk: Suites I
- 0945 - 1115: Desk Work: Suite Writing
Tutorial
- 1115 - 1215: User Feedback and Talk: Suites II
- 1215 - 1330: Break
- 1330 - 1430:
rose stem and
System-specifics
- 1430 - 1445: Break
- 1445 - 1515: Real Suite Demos and
cylc
gui Demo
- 1515 - 1520: Wrap-up
- 1520 - close: Suggested Desk Work: User-selected
Advanced Suite
Tutorials
Post-course: Quiz
It is very useful to stay in touch with trainees
during the desk work sessions, via email or by
physically visiting them (if possible).
Demos
There are a few demos as part of the course. This is
what we usually show:
rose edit demo (in Metadata):
- Use the
demo/rose-config-edit/training/app/cooking
app
- Load in
rose edit, and compare with
the rose-app.conf and
meta/rose-meta.conf files in that
directory
- Switch off metadata compared with switching it on
again (use the menu Metadata -> Switch Off
Metadata)
- Point out how things like values and
description have altered the
display
- Demonstrate how changing a value causes
modification icons - changing it back removes
them
- Demonstrate Undo, Redo, Revert changes, Find
- Demonstrate adding a variable
- Demonstrate removing a variable (show how this is
not possible with the oven_temperature
option because compulsory=true is set in
its metadata)
- Demonstrate triggering via altering
pie_type values - also show triggering
with the menu option View -> All Ignored
Variables
- Demonstrate the fail-if metadata for
pie_type
rosie go demo (in Suite Files and Rosie):
- Show local suites
- Search via the address bar and/or search bar
- Query, via the advanced search interface (press
+ toolbar icon)
- History of past searches via menu option
- Run a suite by right clicking on a suite result
and selecting the relevant menu option
- Same with View Output, Suite Engine
cylc gui demo (second afternoon):
- Use a suitably large suite, such as the ECOX demo
bundled with cylc.
- Change views, show two views at once, show
side-by-side or vertical toggling
- Demonstrate grouping/ungrouping in all views
- Demonstrate filtering in the Tree and Dot
views
- Demonstrate landscape mode in graph view
- Talk about the right click task menu options
(e.g. Reset task state, View logs)
Technical Notes
The documentation includes some links to images
hosted on external sites. This means that an internet
connection (even if a slow one) is necessary unless you
can preload the pages or disable image fetching.
The Rose documentation requires a modern,
standards-compliant browser to work correctly - see the
Rose requirements.