Stricter control of ECF_ variables in suite-definition files

[maddenp-cu]

Synopsis

In ecFlow suitedef vars blocks, accept:

• Arbitrary user-defined variables if they do not start with ECF_
• A fixed set of ECF_ vars accepted in ecFlow suite-definition files.

I've tried to define the correct set of ECF_ variables based on the ecFlow documentation, but I'm not certain the docs are complete or correct, so we may need to update this as we learn more.

Note that, as stated here, variables automatically generated by ecFlow are permitted to be overwritten by users in suite definitions. So, these variables appear in the new schema in addition to those defined here explicitly as suite-definition variables.

Type

• Enhancement (adds new functionality)

Impact

• This is a non-breaking change (existing functionality continues to work as expected)

Checklist

• I have added myself and any co-authors to the PR's Assignees list.
• I have reviewed the documentation and have made any updates necessitated by this change.
• Where helpful, I have written comments in this PR's Files changed view to assist reviewers.

[christinaholtNOAA]

I think the code changes look great, but should we have this information in the docs?

Note that, as stated here, variables automatically generated by ecFlow are permitted to be overwritten by users in suite definitions. So, these variables appear in the new schema in addition to those defined here explicitly as suite-definition variables.

[maddenp-cu]

I think the code changes look great, but should we have this information in the docs?

Note that, as stated here, variables automatically generated by ecFlow are permitted to be overwritten by users in suite definitions. So, these variables appear in the new schema in addition to those defined here explicitly as suite-definition variables.

Good idea. I think we could (and probably should) link to the ecFlow docs for these details, but I wouldn't want to restate them. Let me see what I can add.