Documentation: Update existing use cases to use the template

[jprestop]

Describe the Enhancement

In the METplus-6.0.0-beta6 release cycle the following issue was created and completed:
Documentation: Develop an RST template for use cases #918
The templates have been developed and now we need to update all existing use cases to utilize the templates.

@CPKalb has already started on using the new templates for some of the existing templates.

See Tina's comment on this issue regarding what she is working on.

@lisagoodrich I talked with Dan about how to get started on this task. First we'll start with a spreadsheet identifying what cases we have and which fields need to be changed. We'll talk about all of this before you get started.

Time Estimate

??

Sub-Issues

Consider breaking the enhancement down into sub-issues.

• Add a checkbox for each sub-issue here.

Relevant Deadlines

The current funding for this work ends on 12/31/2024.

Funding Source

7730022

Define the Metadata

Assignee

• Select engineer(s) or no engineer required
• Select scientist(s) or no scientist required

Labels

• Review default alert labels
• Select component(s)
• Select priority
• Select requestor(s)

Milestone and Projects

• Select Milestone as a METplus-Wrappers-X.Y.Z version, Consider for Next Release, or Backlog of Development Ideas
• For a METplus-Wrappers-X.Y.Z version, select the METplus-Wrappers-X.Y.Z Development project

Define Related Issue(s)

Consider the impact to the other METplus components.

• METplus, MET, METdataio, METviewer, METexpress, METcalcpy, METplotpy

Enhancement Checklist

See the METplus Workflow for details.

• Complete the issue definition above, including the Time Estimate and Funding Source.
• Fork this repository or create a branch of develop.
  Branch name: feature_<Issue Number>_<Description>
• Complete the development and test your changes.
• Add/update log messages for easier debugging.
• Add/update unit tests.
• Add/update documentation.
• Add any new Python packages to the METplus Components Python Requirements table.
• For any new datasets, an entry to the METplus Verification Datasets Guide.
• Push local changes to GitHub.
• Submit a pull request to merge into develop.
  Pull request: feature <Issue Number> <Description>
• Define the pull request metadata, as permissions allow.
  Select: Reviewer(s) and Development issue
  Select: Milestone as the next official version
  Select: METplus-Wrappers-X.Y.Z Development project for development toward the next official release
• Iterate until the reviewer(s) accept and merge your changes.
• Delete your fork or branch.
• Close this issue.

[CPKalb]

@lisagoodrich, @jprestop

The ones I have been working on are part of issue 2628. While I'm updating the scientific objective, I am also moving them to the new template. The use cases include:

s2s_mid_lat:
UserScript_fcstGFS_obsERA_Blocking
UserScript_obsERA_obsOnly_Blocking
UserScript_fcstGFS_obsERA_WeatherRegime
UserScript_obsERA_obsOnly_WeatherRegime

s2s_mjo:
UserScript_fcstGFS_obsERA_OMI
UserScript_obsERA_obsOnly_OMI
UserScript_obsERA_obsOnly_RMM
UserScript_obsERA_obsOnly_PhaseDiagram

s2s_stratosphere:
UserScript_fcstGFS_obsERA_StratosphereBias
UserScript_fcstGFS_obsERA_StratospherePolar
UserScript_fcstGFS_obsERA_StratosphereQBO

This is basically all the use cases in s2s_mid_lat and s2s_stratosphere, but there are others in the s2s_mjo area that are not part of that issue. Let me know if you you want me to just do all the s2s_mjo use cases...

The s2s_mid_lat and s2s_mjo use cases are done and I still need to finish up the stratosphere ones. I'll do that under issue 2628 since I've already been working there.

[jprestop]

@CPKalb Thank you so much for this helpful information! I really appreciate you taking the time so quickly to list these cases here.

[CPKalb]

@jprestop, it looks like the updated documentation has a section for "Version Added." If we are unsure which version of METplus a use case was added, is there a way to get this information?

[jprestop]

@jprestop, it looks like the updated documentation has a section for "Version Added." If we are unsure which version of METplus a use case was added, is there a way to get this information?

@CPKalb That is a great question. I tried to look this up via google, but my search strings were not producing the results I was looking for.

In looking for the version where UserScript_fcstGFS_obsERA_Blocking was added, I believe I was able to find this information. Here are the steps I took (see video of me walking through it):

• Navigate to the use case in the repository (in this case develop/docs/use_cases/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking.py)
• Click on "Blame"
• Scroll down to the bottom and look at the left hand column to find the earliest feature number associated with this file
• Look up that closed issue in the respository
• Ensure that it does have to do with the creation of this use case
• Look at the milestone assigned to it

I'm wondering if @JohnHalleyGotway knows of a more straightforward way to get this information. The method I have found here is time consuming and if the milestone wasn't selected, it could prove to be more difficult to figure out.

[georgemccabe]

@jprestop, I did something similar to get this information.

You can also click on the use case doc file, then click on "History" and scroll to the earliest commit to see when it was added. In this case, the file was renamed, but there is a link to see the history before the rename (click "Browse History"). From there, I see the earliest commit was from PR #856, so I clicked on the link to navigate to that PR. From there I can see that it was added for Milestone 4.0.0.

Screen.Recording.2024-10-23.at.1.07.58.PM.mov