- application directory
The application directory is the folder in which the
rose-app.conffile is located in a Rose application configuration.
- Rose metadata
Rose metadata provides information about settings in Rose application configurations and Rose suite configurations. This information is stored in a
rose-meta.conffile in a
meta/directory alongside the configuration it applies to.
This information can include:
Documentation and help text, e.g.
rose-meta.conf[SETTING]titleprovides a short title to describe a setting.
Information about permitted values for the setting, e.g.
rose-meta.conf[SETTING]typecan 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.
Metadata which defines how settings should behave in different states (e.g.
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.
- Rose app
- Rose application
- Rose application configuration
A Rose application configuration (or Rose app) is a directory containing a
rose-app.conffile along with some other optional files and directories.
An application can configure:
The command to run (
Any environment variables to provide it with (
Input files e.g. namelists (
Metadata for the application (
- Rose built-in application
A Rose built-in application is a generic Rose application providing common functionality which is provided in the Rose installation.
- 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 suite configuration
A Rose suite configuration is a
rose-suite.conffile 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
Environment variables to be provided to
Installation configuration (e.g.
- 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.