Cylc-Rose Plugin
A Cylc plugin providing support for the
Rose rose-suite.conf file.
For use with Cylc 8 and Rose 2.
Installation
Install from PyPi:
pip install cylc-rose
Or Conda:
conda install cylc-rose
No further configuration is required, Cylc will load this plugin automatically.
Overview
In the past Rose provided a wrapper to Cylc providing additional capabilities including workflow installation.
As of Cylc 8 and Rose 2 some of this functionality has been re-built directly in Cylc, the rest has been migrated into this Plugin.
The last versions of Cylc and Rose which use the wrapper are:
- Cylc 7
- Rose 2019
For all later versions please install this plugin into your Cylc/Rose environment for Rose integration.
What This Plugin Does
This plugin provides support for the rose-suite.conf file, namely:
- Jinja2 template variables.
- Scheduler environment variables.
- File installation.
- Optional configurations.
What This Plugin Does Not Do
- Support the
root-dir*configurations, these have been deprecated by the new Cylcsymlink dirsfunctionality. - Graphical configuration editors.
How It Works
For developer documentation, see DEVELOPING.
Contributing
- Read the contributing page.
- Development setup instructions are in the developer docs.
- Involved change proposals can be found in the admin pages.
- Touch base in the developers chat.
Note: If also developing Cylc and or Rose you may wish to install cylc-rose in the same environment before installing cylc-rose.
pip install -e cylc-rose[all]
Copyright and Terms of Use
Copyright (C) 2008-2026 Earth Sciences New Zealand & British Crown (Met Office) & Contributors.
Cylc-rose is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Cylc-rose is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with Cylc-rose. If not, see GNU licenses.
2 maintainers
Metadata
2 maintainers
Release files for cylc-rose 1.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cylc_rose-1.8.0.tar.gz | 40.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cylc_rose-1.8.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 82.4 kB
Release files / cylc_rose-1.8.0.tar.gz
| Download URL | cylc_rose-1.8.0.tar.gz |
|---|---|
| Size | 40.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1f9b4c4439f45cf0caf8a237130ce5e2de16e730a8d456c0b2d4a6aec8b30fbf
|
|
BLAKE2b-256 checksum How to use checksums |
05f1fba9e533bf61d628bd3f7737481d17846e3266891dc06071bf2d64f15b5a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / cylc_rose-1.8.0-py3-none-any.whl
| Download URL | cylc_rose-1.8.0-py3-none-any.whl |
|---|---|
| Size | 42.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
703962ac453071b60ba8612589e6001e06999ca3734c740687db6e57d49a9f4e
|
|
BLAKE2b-256 checksum How to use checksums |
910f205c4feea2ec1d3e07d586c28772d434b9d4daf30bab40166c95cd2130d0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
