Glossary§

application directory

The application directory is the folder in which the rose-app.conf file is located in a Rose application configuration.

metadata

Rose metadata

Rose metadata provides information about settings in Rose application configurations and Rose suite configurations. This information is stored in a rose-meta.conf file in a meta/ directory alongside the configuration it applies to.

This information can include:

• Documentation and help text, e.g. rose-meta.conf[SETTING]title provides a short title to describe a setting.
• Information about permitted values for the setting, e.g. rose-meta.conf[SETTING]type can be used to specify the data type a setting requires (integer, string, boolean, etc).
• Settings affecting how the configurations are displayed in rose config-edit (e.g. rose-meta.conf[SETTING]sort-key).
• Metadata which defines how settings should behave in different states (e.g. rose-meta.conf[SETTING]trigger).

This information is used for:

• Presentation and validation in the rose config-edit GUI.
• Validation using the rose macro command.

Metadata does not affect the running of an application or workflow.

See also:

• Configuration Metadata

Rose app

Rose application

Rose application configuration

A Rose application configuration (or Rose app) is a directory containing a rose-app.conf file along with some other optional files and directories.

An application can configure:

• The command to run (rose-app.conf[command]).
• Any environment variables to provide it with (rose-app.conf[env])
• Input files e.g. namelists (rose-app.conf[namelist:NAME])
• Metadata for the application (rose-meta.conf).

See also:

• Application Configuration

Rose built-in application

A Rose built-in application is a generic Rose application providing common functionality which is provided in the Rose installation.

See also:

• Rose Built-In Applications

Rose configuration

Rose configurations are directories containing a Rose configuration file along with other optional files and directories.

The two types of Rose configuration relevant to Cylc workflows are:

• Rose application configuration
• Rose suite configuration

See also:

• Rose Configuration Format
• Rose Configuration Tutorial
• Optional Configuration Tutorial

Rose suite configuration

A Rose suite configuration is a rose-suite.conf file along with other optional files and directories which configure the way in which a workflow is run. E.g:

• Jinja2 variables to be passed into the flow.cylc file ( rose-suite.conf[jinja2:suite.rc]).
• Environment variables to be provided to cylc play ( rose-suite.conf[env]).
• Installation configuration (e.g. rose-suite.conf[file:NAME]).

See also:

• Suite Configuration

Rosie Suite

A Rosie suite is a Rose suite configuration which is managed using the Rosie system.

When a suite is managed using Rosie:

• The run directory is added to version control.
• The suite is registered in a database.

See also:

• Rosie Tutorial