A Cylc plugin providing support for the Rose rose-suite.conf file.
This is a work in-progress project for use with the Cylc8 and Rose2.
Note: This plugin has not yet been relesed on pypi/conda-forge
Install from PyPi:
$ pip install cylc-rose
$ conda install cylc-rose
No further configuration is required, Cylc will load this plugin automatically.
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/EmPy 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 Cylc
- Graphical configuration editors.
- 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 (C) 2008-2021 NIWA & 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.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size cylc_rose-0.2-py3-none-any.whl (34.6 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size cylc-rose-0.2.tar.gz (32.1 kB)||File type Source||Python version None||Upload date||Hashes View|