Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Major Changes - Cylc Install - Rose Stem #68

Merged
merged 3 commits into from
Jul 21, 2021
Merged

Major Changes - Cylc Install - Rose Stem #68

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cabbdef
Added More details of the working of rose stem to docs
wxtim Jul 19, 2021
2209852
added a note about rose-suites and cylc-workflows
wxtim Jul 20, 2021
2ac0209
Update cylc/rose/__init__.py
wxtim Jul 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 47 additions & 5 deletions cylc/rose/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,33 @@

Cylc Rose is the bridge between Rose suite configurations and Cylc workflows.

Cylc Rose is a replacement for the ``rose suite-run`` command (present in Rose
versions 2019.01 and earlier). It reads the ``rose-suite.conf`` file and
performs the required actions.
Cylc Rose allows ``cylc install`` to replace the ``rose suite-run``
command (present in Rose versions 2019.01 and earlier). It reads the
``rose-suite.conf`` file and:

- Makes environment and template variables available
to Cylc.
- Installs files.
- Records information in about the configuration installed in
``~/cylc-run/<workflow>/opt/rose-suite-cylc-install.conf``


The following Cylc commands will read Rose Suite Configurations:

- ``cylc validate``
- ``cylc graph``
- ``cylc list``
- ``cylc config``


Rose Config
-----------

.. attention::

Rose configurations for Cylc **workflows** continue to be referred to
as Rose **suites**.

A fuller description of
:ref:`rose suite config is available here<Rose Suites>`.

Expand Down Expand Up @@ -113,12 +133,34 @@
+ [[Hello_Mars]]


.. _rose-stem:

Rose Stem
=========

.. seealso::

`Rose Stem documentation
<https://metomi.github.io/rose/2019.01.2/html/tutorial/rose/furthertopics/
rose-stem.html>`_
wxtim marked this conversation as resolved.
Show resolved Hide resolved


Cylc Rose provides a Rose Stem command, if FCM is installed on your system.
See `the Rose Stem documentation
<https://metomi.github.io/rose/2019.01.2/html/tutorial/rose/furthertopics/rose-stem.html>`_
At Cylc 8 Rose Stem is a wrapper to ``cylc install`` rather than
``rose suite-run``.

Rose Stem is a wrapper around the ``cylc install`` command which
provides some additional jinja2 variables.
wxtim marked this conversation as resolved.
Show resolved Hide resolved

Cylc 8 stores variables set by rose and rose-stem in the optional
configuration file ``~/cylc-run/my_workflow/opt/rose-suite-cylc-install.conf``.

.. caution::

To reinstall a rose stem suite use ``cylc reinstall``. Cylc can get any
options you do not change from the ``rose-suite-cylc-install.conf``` file.
Using ``rose stem`` a second time will attempt install a new copy
of your rose stem suite.

"""

Expand Down