Automate the creation of the variables list

[jrackham-mo]

Closes #132 and #186.

PR creation checklist for the developer

• Does the feature branch name follow the format <issue_number>_<short_description_of_feature>?
• Does the PR title exactly match with the issue title?
• Have appropriate reviewers been added to the PR (once it is ready for review)?
• Has the PR been assigned to the developer?
• Has the Climate Model Evaluation Workflow (CMEW) project been added to the PR?
• Has the appropriate milestone been added to the PR?

Definition of Done for the developer

• Does the change in this PR address the above issue / have all acceptance criteria been met?
• Does the change in this PR follow the recommendations in the wiki: Developer Guide?
• Have new tests related to the change been added?
• Do all the GitHub workflow checks pass?
• Do all the tests run locally and pass? (Note: the tests are not run by the GitHub workflow, see wiki: Run the tests locally)
• Has the API documentation related to the change been updated appropriately?
• Has the user documentation related to the change been updated appropriately?
• Do the HTML pages render correctly? (See wiki: Build the documentation locally)
• Do the steps in the Quick Start section of the documentation work?

PR creation checklist for the reviewer

• Does the feature branch name follow the format <issue_number>_<short_description_of_feature>?
• Does the PR title exactly match with the issue title?
• Have appropriate reviewers been added to the PR (once it is ready for review)?
• Has the PR been assigned to the developer?
• Has the Climate Model Evaluation Workflow (CMEW) project been added to the PR?
• Has the appropriate milestone been added to the PR?

Definition of Done for the reviewer

• Does the change in this PR address the above issue / have all acceptance criteria been met?
• Does the change in this PR follow the recommendations in the wiki: Developer Guide?
• Have new tests related to the change been added?
• Do all the GitHub workflow checks pass?
• Do all the tests run locally and pass? (Note: the tests are not run by the GitHub workflow, see wiki: Run the tests locally)
• Has the API documentation related to the change been updated appropriately?
• Has the user documentation related to the change been updated appropriately?
• Do the HTML pages render correctly? (See wiki: Build the documentation locally)
• Do the steps in the Quick Start section of the documentation work?

[dasha-shchep]

Looks good to me!

[jrackham-mo]

The configure_standardise task is now parameterised by assessment area, but it still writes only one variables.txt file. This means that if we introduce multiple assessment areas, then the variables.txt file will get overwritten each time. Perhaps in the future we should name the files more specifically e.g. <assessment_area>_variables.txt. Then we'd also have to modify standardise_model_data to pick up each assessment area's variables file. I imagine we'd have the same issue with the request.json file. For now, we're only dealing with one assessment are, so the issue of reading/writing multiple variables.txt files can be deferred.

[ehogan]

The configure_standardise task is now parameterised by assessment area, but it still writes only one variables.txt file. This means that if we introduce multiple assessment areas, then the variables.txt file will get overwritten each time. Perhaps in the future we should name the files more specifically e.g. <assessment_area>_variables.txt. Then we'd also have to modify standardise_model_data to pick up each assessment area's variables file. I imagine we'd have the same issue with the request.json file. For now, we're only dealing with one assessment are, so the issue of reading/writing multiple variables.txt files can be deferred.

Would you be happy to open a new issue for this? (Click on the three dots next to your comment and select "Reference in new issue") 😁

[jrackham-mo]

Would you be happy to open a new issue for this? (Click on the three dots next to your comment and select "Reference in new issue") 😁

Done #184

[ehogan]

Super stuff, thank you very much @jrackham-mo! 🥳

[ehogan]

Amazing, thank you @jrackham-mo! 🎉

[dasha-shchep]

Add to the original comment that this also closes #186

[jrackham-mo]

Add to the original comment that this also closes #186

Updated

[ehogan]

Great work @jrackham-mo and @dasha-shchep! 🥳 I wanted to add that we did discuss doing the last change made on this branch via #186, but we decided that since it was very related to the changes made here that it made sense to make the change via this PR 😊

[ehogan]

Looks good! 🥳