Skip to content
New issue

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

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

Already on GitHub? # to your account

macros and core rose-stem #291

Merged
merged 5 commits into from
Dec 19, 2024
Merged

macros and core rose-stem #291

merged 5 commits into from
Dec 19, 2024

Conversation

james-bruten-mo
Copy link
Contributor

Add some clarifications to LFRic Upgrade Macros and change LFRic Core testing instructions to use cylc8 commands

Copy link
Collaborator

@jennyhickson jennyhickson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for sorting. A couple of trivial tweaks/suggestions

@@ -3,11 +3,12 @@
Testing LFRic Core
==================

LFRic testing is run with the following command from a working copy:
LFRic testing is now Cylc8 only and launched with rose-stem commands:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To make this slightly less of the moment I'd suggest just including the "export CYLC_VERSION=8" in the command and use this headline sentence to just say that LFRic Core uses rose-stem (like Apps, UM etc).

It might then be worth a "note" box to say that calling make test-suite was deprecated from the core2.0 revision or something like that?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@@ -92,6 +92,10 @@ The organisation of LFRic metadata is different from other repositories (UM + Ju

To solve this, macros in LFRic Apps are applied using a wrapper script which will read the added macros and combine them into the versions.py files for the apps where that metadata is imported. Therefore when adding macros, the macro should be added in the versions.py file in the same metadata directory as the metadata change being made. It will then be shared as appropriate by the ``apply_macros.py`` script.

.. tip::

The macro will only end up in versions.py files for metadata that is directly imported by a rose-stem app. Therefore if adding to eg. Science/gungho, the macro will be deleted from that file by the script.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if a final sentence on here to drive home the "make sure you're ready for things to be deleted" message?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

source/WorkingPractices/macros.rst Outdated Show resolved Hide resolved
james-bruten-mo and others added 4 commits December 19, 2024 09:41
Co-authored-by: Jenny Hickson <61183013+jennyhickson@users.noreply.github.com>
@james-bruten-mo
Copy link
Contributor Author

Thanks Jenny, updated all those

@jennyhickson jennyhickson merged commit 79451cd into main Dec 19, 2024
5 checks passed
@jennyhickson jennyhickson deleted the vn2.0_changes branch December 19, 2024 10:12
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants