Changes between Version 6 and Version 7 of ngm/suites/PortingGuide

Timestamp:

May 2, 2022 2:16:10 PM (3 months ago)

Author:

Scott Wales

Comment:

--

ngm/suites/PortingGuide

@@ -66 +66 @@
 === opt Files
 
-If values in a rose-app.conf file need to be changed to run at NCI and will not normally need to be altered by users they can be overridden in an 'opt' file
+If values in a rose-app.conf file need to be changed to run at NCI and will not normally need to be altered by users they can be overridden in an 'opt' file.
+
+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.
+
+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.
+
+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`
+
+Suite opt files similarly use environment variable `ROSE_SUITE_OPT_CONF_KEYS` or flag `--opt-conf-key=KEY`.
+
+Apps may set ROSE_APP_OPT_CONF_KEYS for their own purposes, e.g. to select model resolution. You can override the root script and add the flag there to avoid conflicts. Putting the key in parentheses means it won't cause an error if the file isn't present
+{{{
+[runtime]
+    [[root]]
+        script = "rose task-run --verbose --opt-conf-key=(nci-gadi)"
+}}}