A Cylc plugin providing support for the Rose rose-suite.conf file.
Project description
Cylc-Rose Plugin
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.
Installation
Note: This plugin has not yet been relesed on pypi/conda-forge
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/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 Cylcsymlink dirs
functionality. - Graphical configuration editors.
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-2022 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cylc_rose-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1459d1b128155be00aff4494349ee15ae3ecbfb702241bdda3afc798e365514 |
|
MD5 | 684e35bc4c028fcccbe830c634e2f424 |
|
BLAKE2b-256 | ad6a2ad710a2bf901203513d1365629acb955fc0979a8a6301423973c8de30f0 |