Development

Here are discussed some of the choices made during the development of the project (coding styles for different languages, pattern used in Cylc, etc).

You’ll also find some guidelines on how to add a new task or configuration option to the workflow.

Note

It is assumed that you have a basic understanding of:

• Cylc,

• Python, R and Bash.

For further information on Cylc, please consult their User Guide .

• Workflow design choices
  • Following Cylc’s best practices
  • Jinja2 templating
  • Rose for configuration management
  • Task inheritance to avoid code duplication
  • Run setup is done at the first cyclepoint
  • Tasks can run in specific conda environments
  • dataflow/ and qc/ directories for results
  • Data tables are stored in plain text CSV files
  • Libraries/packages to be favored
  • InfluxDB is an optional dependency
• Coding style
  • bin/ scripts: environment variables or command line arguments?
  • Cylc
  • Python
  • Bash
  • R
• Adding a task to the workflow
  • Adding a python script to the workflow executables
  • Creating a new task in the [runtime] section
  • Adding the task to the graph
  • Testing the new task
• Adding an item to user configuration
  • Write a new item in rose-suite.conf
  • Use the template variable in the workflow definition
  • Validate the new configuration item