# Cylc-Rose Plugin
[](https://pypi.org/project/cylc-rose/)
[](https://github.com/cylc/cylc-rose/actions/workflows/tests.yml)
[](https://app.codecov.io/gh/cylc/cylc-rose)
A [Cylc](https://github.com/cylc/cylc-flow) plugin providing support for the
[Rose](https://github.com/metomi/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/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 `symlink dirs` functionality.
* Graphical configuration editors.
### How It Works
For developer documentation, see [DEVELOPING](DEVELOPING.md).
### Contributing
[](https://github.com/cylc/cylc-rose/graphs/contributors)
[](https://github.com/cylc/cylc-rose/commits/master)
[](https://github.com/cylc/cylc-rose/commits/master)
* Read the [contributing](CONTRIBUTING.md) page.
* Development setup instructions are in the
[developer docs](https://cylc.github.io/cylc-admin/#cylc-8-developer-docs).
* Involved change proposals can be found in the
[admin pages](https://cylc.github.io/cylc-admin/#change-proposals).
* Touch base in the
[developers chat](https://matrix.to/#/#cylc-general:matrix.org).
> **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
[](https://github.com/cylc/cylc-flow/blob/master/COPYING)
Copyright (C) 2008-<span actions:bind='current-year'>2024</span> 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](http://www.gnu.org/licenses/).
Raw data
{
"_id": null,
"home_page": "https://cylc.github.io/cylc-doc/latest/html/plugins/cylc-rose.html",
"name": "cylc-rose",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "cylc, rose, workflow, configuration, workflow-engine, workflow-automation, workflow-management",
"author": "British Crown (Met Office) & Contributors",
"author_email": "metomi@metoffice.gov.uk",
"download_url": "https://files.pythonhosted.org/packages/32/d5/1d7b78ba90050cf84ed4a0d1859493cc256cac8ca06131e8e952aeb74d6b/cylc_rose-1.4.1.tar.gz",
"platform": "any",
"description": "# Cylc-Rose Plugin\n\n[](https://pypi.org/project/cylc-rose/)\n[](https://github.com/cylc/cylc-rose/actions/workflows/tests.yml)\n[](https://app.codecov.io/gh/cylc/cylc-rose)\n\nA [Cylc](https://github.com/cylc/cylc-flow) plugin providing support for the\n[Rose](https://github.com/metomi/rose) `rose-suite.conf` file.\n\nFor use with Cylc 8 and Rose 2.\n\n### Installation\n\nInstall from PyPi:\n\n```\npip install cylc-rose\n```\n\nOr Conda:\n\n```\nconda install cylc-rose\n```\n\nNo further configuration is required, Cylc will load this plugin automatically.\n\n### Overview\n\nIn the past Rose provided a wrapper to Cylc providing additional capabilities\nincluding workflow installation.\n\nAs of Cylc 8 and Rose 2 some of this functionality has been re-built directly\nin Cylc, the rest has been migrated into this Plugin.\n\nThe last versions of Cylc and Rose which use the wrapper are:\n\n* Cylc 7\n* Rose 2019\n\nFor all later versions please install this plugin into your Cylc/Rose\nenvironment for Rose integration.\n\n### What This Plugin Does\n\nThis plugin provides support for the `rose-suite.conf` file, namely:\n\n* Jinja2/EmPy template variables.\n* Scheduler environment variables.\n* File installation.\n* Optional configurations.\n\n### What This Plugin Does Not Do\n\n* Support the `root-dir*` configurations, these have been deprecated by\n the new Cylc `symlink dirs` functionality.\n* Graphical configuration editors.\n\n### How It Works\n\nFor developer documentation, see [DEVELOPING](DEVELOPING.md).\n\n### Contributing\n\n[](https://github.com/cylc/cylc-rose/graphs/contributors)\n[](https://github.com/cylc/cylc-rose/commits/master)\n[](https://github.com/cylc/cylc-rose/commits/master)\n\n* Read the [contributing](CONTRIBUTING.md) page.\n* Development setup instructions are in the\n [developer docs](https://cylc.github.io/cylc-admin/#cylc-8-developer-docs).\n* Involved change proposals can be found in the\n [admin pages](https://cylc.github.io/cylc-admin/#change-proposals).\n* Touch base in the\n [developers chat](https://matrix.to/#/#cylc-general:matrix.org).\n\n> **Note:** If also developing Cylc and or Rose you may wish to install\n cylc-rose in the same environment before installing cylc-rose.\n\n```\npip install -e cylc-rose[all]\n```\n\n### Copyright and Terms of Use\n\n[](https://github.com/cylc/cylc-flow/blob/master/COPYING)\n\nCopyright (C) 2008-<span actions:bind='current-year'>2024</span> NIWA &\nBritish Crown (Met Office) & Contributors.\n\nCylc-rose is free software: you can redistribute it and/or modify it under the terms\nof the GNU General Public License as published by the Free Software Foundation,\neither version 3 of the License, or (at your option) any later version.\n\nCylc-rose is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A\nPARTICULAR PURPOSE. See the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along with\nCylc-rose. If not, see [GNU licenses](http://www.gnu.org/licenses/).\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "A Cylc plugin providing support for the Rose rose-suite.conf file.",
"version": "1.4.1",
"project_urls": {
"Homepage": "https://cylc.github.io/cylc-doc/latest/html/plugins/cylc-rose.html"
},
"split_keywords": [
"cylc",
" rose",
" workflow",
" configuration",
" workflow-engine",
" workflow-automation",
" workflow-management"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9f41129aaf78cc4c3c7cc724f1f585bbb40a0c6211d2cbaf13438d48e9fa1d11",
"md5": "5019174f916ed5cfe723822f5e265925",
"sha256": "afe334840cf82cb4e561e818cca57a72a69e7fa722eeebcea497ac86b44787d3"
},
"downloads": -1,
"filename": "cylc_rose-1.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5019174f916ed5cfe723822f5e265925",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 43076,
"upload_time": "2024-07-23T16:46:14",
"upload_time_iso_8601": "2024-07-23T16:46:14.401208Z",
"url": "https://files.pythonhosted.org/packages/9f/41/129aaf78cc4c3c7cc724f1f585bbb40a0c6211d2cbaf13438d48e9fa1d11/cylc_rose-1.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "32d51d7b78ba90050cf84ed4a0d1859493cc256cac8ca06131e8e952aeb74d6b",
"md5": "447d12c71e7b6e25efb2f38a8f0ac476",
"sha256": "390ec60dcfa6c364073c669733b548233afa5cf5c22cf23345b6eeae731c9f29"
},
"downloads": -1,
"filename": "cylc_rose-1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "447d12c71e7b6e25efb2f38a8f0ac476",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 39929,
"upload_time": "2024-07-23T16:46:16",
"upload_time_iso_8601": "2024-07-23T16:46:16.359302Z",
"url": "https://files.pythonhosted.org/packages/32/d5/1d7b78ba90050cf84ed4a0d1859493cc256cac8ca06131e8e952aeb74d6b/cylc_rose-1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-23 16:46:16",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cylc-rose"
}
JSON