16. Suite Design Guide

Cylc Rose Suite Design Best Practice Guide

Version 1.0 - 23 March 2017

Last updated for: Cylc-7.2.0 and Rose-2017.02.0

Hilary Oliver, Dave Matthews, Andy Clark, and Contributors

---

• 16.1. Introduction
• 16.2. Style Guidelines
  • 16.2.1. Tab Characters
  • 16.2.2. Trailing Whitespace
  • 16.2.3. Indentation
  • 16.2.4. Comments
  • 16.2.5. Titles, Descriptions, And URLs
  • 16.2.6. Line Length And Continuation
  • 16.2.7. Task Naming Conventions
  • 16.2.8. Rose Config Files
• 16.3. Basic Principles
  • 16.3.1. UTC Mode
  • 16.3.2. Fine Or Coarse-Grained Suites
  • 16.3.3. Monolithic Or Interdependent Suites
  • 16.3.4. Self-Contained Suites
  • 16.3.5. Task Host Selection
  • 16.3.6. Task Scripting
  • 16.3.7. Rose Apps
  • 16.3.8. Rose Metadata Compliance
  • 16.3.9. Task Independence
  • 16.3.10. Clock-Triggered Tasks
  • 16.3.11. Rose App File Polling
  • 16.3.12. Task Execution Time Limits
  • 16.3.13. Restricting Suite Activity
  • 16.3.14. Suite Housekeeping
  • 16.3.15. Complex Jinja2 Code
  • 16.3.16. Shared Configuration
  • 16.3.17. Automating Failure Recovery
  • 16.3.18. Include Files
• 16.4. Efficiency And Maintainability
  • 16.4.1. The Task Family Hierarchy
  • 16.4.2. Generating Tasks Automatically
  • 16.4.3. Optional App Config Files
• 16.5. Portable Suites
  • 16.5.1. The Jinja2 SITE Variable
  • 16.5.2. Site Include-Files
  • 16.5.3. Site-Specific Graphs
  • 16.5.4. Inlined Site-Switching
  • 16.5.5. Site-Specific Suite Variables
  • 16.5.6. Site-Specific Optional Suite Configs
  • 16.5.7. Site-Agnostic File Paths in App Configs
  • 16.5.8. Site-Specific Optional App Configs
  • 16.5.9. An Example
  • 16.5.10. Collaborative Development Model
  • 16.5.11. Research-To-Operations Transition
• 16.6. Roadmap
  • 16.6.1. List Item Override In Site Include-Files
  • 16.6.2. UM STASH in Optional App Configs
  • 16.6.3. Modular Suite Design

---