Changes between Version 7 and Version 8 of ngm/suites/PortingGuide
- Timestamp:
- May 2, 2022 2:26:17 PM (2 months ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
ngm/suites/PortingGuide
v7 v8 3 3 == Suite Porting Guide 4 4 5 [https://cylc.github.io/cylc-doc/latest/html/workflow-design-guide/index.html Rose & Cylc Workflow Design Guidelines]5 These tips are for porting existing suites to run on NCI. You should also check the [https://cylc.github.io/cylc-doc/latest/html/workflow-design-guide/index.html Rose & Cylc Workflow Design Guidelines] 6 6 7 7 To run on Gadi, suites should contain either a file `sites/nci-gadi.rc` or directory `sites/nci-gadi` that contain Cylc settings appropriate for Gadi. Settings in this file will overwrite those in the main `suite.rc` file, which will normally have at the end of the file `{% include "sites/"~SITE~".rc" %}` or similar to include the site information. 8 9 In genearal: 10 - Be consistent with other site setups in the same suite 11 - Prefer simplicity as much as possible over Jinja use 8 12 9 13 === Standard Variables … … 70 74 Overrides done this way should be minimal, as they're hard to notice in the GUI and can be confusing when a user tries to adjust them, as the override will reset. 71 75 72 Opt files are stored in the `opt` directory, either of the suite as a whole or of a specific app. In either case, when enabled they will replace the settings in `rose-suite.conf` or that app's `rose-app.conf` respectively with the values set in the file. 73 74 Opt files are enabled in a Rose app by setting the environment variable `ROSE_APP_OPT_CONF_KEYS` to a space-separated list of options to enable, or by adding the flag `--opt-conf-key=KEY` to `rose task-run`. When running an app Rose will read the opt file from `app/APP/opt/rose-app-KEY.conf` 76 Opt files are enabled in a Rose app by setting the environment variable `ROSE_APP_OPT_CONF_KEYS` to a space-separated list of options to enable, or by adding the flag `--opt-conf-key=KEY` to `rose task-run`. When running an app Rose will read the opt file from any selected `app/APP/opt/rose-app-KEY.conf`, and use the values set there instead of those set in rose-app.conf or the GUI. 75 77 76 78 Suite opt files similarly use environment variable `ROSE_SUITE_OPT_CONF_KEYS` or flag `--opt-conf-key=KEY`.