Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature 2628 documentation updates #2817

Merged
merged 136 commits into from
Dec 19, 2024

Conversation

CPKalb
Copy link
Contributor

@CPKalb CPKalb commented Dec 9, 2024

Pull Request Testing

  • Describe testing already performed for these changes:

    Tested that the documentation builds successfully and also read the documentation to check that they

  • Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:

    Read the documentation for the use cases that were updated and check that they use the new format and also check to see if there are typos or text that does not make sense. The use cases that were updated are:

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

Link to the updated documentation: https://metplus.readthedocs.io/en/feature_2628_documentation_updates/generated/model_applications/index.html#subseasonal-to-seasonal-mid-latitude

  • Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes or No]
    Yes

  • Do these changes include sufficient testing updates? [Yes or No]
    ??

  • Will this PR result in changes to the test suite? [Yes or No]

    If yes, describe the new output and/or changes to the existing output:

    No

  • Do these changes introduce new SonarQube findings? [Yes or No]

    If yes, please describe:
    No

  • Please complete this pull request review by [Fill in date].

Pull Request Checklist

See the METplus Workflow for details.

  • Add any new Python packages to the METplus Components Python Requirements table.
  • For any new datasets, an entry to the METplus Verification Datasets Guide.
  • Review the source issue metadata (required labels, projects, and milestone).
  • Complete the PR definition above.
  • Ensure the PR title matches the feature or bugfix branch name.
  • Define the PR metadata, as permissions allow.
    Select: Reviewer(s) and Development issue
    Select: Milestone as the version that will include these changes
    Select: Coordinated METplus-X.Y Support project for bugfix releases or METplus-Wrappers-X.Y.Z Development project for official releases
  • After submitting the PR, select the ⚙️ icon in the Development section of the right hand sidebar. Search for the issue that this PR will close and select it, if it is not already selected.
  • After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
  • Close the linked issue and delete your feature or bugfix branch from GitHub.

CPKalb and others added 20 commits December 17, 2024 14:01
…A_obsOnly_WeatherRegime.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…fcstGFS_obsERA_StratosphereBias.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…fcstGFS_obsERA_StratosphereBias.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…fcstGFS_obsERA_StratosphereBias.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…sOnly_RMM.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…sOnly_RMM.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…sOnly_RMM.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…sOnly_RMM.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…sOnly_RMM.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…sOnly_RMM.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…sOnly_RMM.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…fcstGFS_obsERA_StratosphereBias.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…fcstGFS_obsERA_StratosphereBias.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…fcstGFS_obsERA_StratospherePolar.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…fcstGFS_obsERA_StratospherePolar.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…fcstGFS_obsERA_StratospherePolar.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…sOnly_RMM.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…sOnly_RMM.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…sOnly_RMM.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
…sOnly_RMM.py

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
Copy link
Contributor Author

@CPKalb CPKalb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Committing requested changes

@CPKalb CPKalb requested a review from jprestop December 18, 2024 20:29
Copy link
Collaborator

@jprestop jprestop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for all of your work on this @CPKalb. The information you added to these use cases is really beneficial. I will note that there is one failed case (see below for summary information) which is expected due to a file name change. I approve this PR.

Summary:


ERROR: Some differences were found
file not found (in truth but missing now)
A:/data/truth/s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking/s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking/plots/FV3_ERA_IBL_Freq_DJF.png
B:

file not found (in truth but missing now)
A:/data/truth/s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking/s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking/plots/FV3_ERA_IBL_Freq_DJF.pdf
B:

file not found (new output)
A:
B:/data/output/s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking/s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking/plots/GFS_ERA_IBL_Freq_DJF.pdf

file not found (new output)
A:
B:/data/output/s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking/s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking/plots/GFS_ERA_IBL_Freq_DJF.png

@georgemccabe georgemccabe merged commit 84b32cf into develop Dec 19, 2024
69 of 70 checks passed
@georgemccabe georgemccabe deleted the feature_2628_documentation_updates branch December 19, 2024 20:59
georgemccabe pushed a commit that referenced this pull request Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue requestor: Navy/NRL Naval Research Laboratory
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Scientific Objective Documentation for some S2S Use Cases
3 participants