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

[develop]: Add sample verification case w/instructions #500

Merged
merged 34 commits into from
Dec 2, 2022
Merged

[develop]: Add sample verification case w/instructions #500

merged 34 commits into from
Dec 2, 2022

Conversation

gspetro-NOAA
Copy link
Collaborator

@gspetro-NOAA gspetro-NOAA commented Nov 30, 2022

DESCRIPTION OF CHANGES:

This PR includes a new chapter in the documentation for VX sample cases. Users can run through the case(s) to (1) learn to use the basic verification features and (2) compare any forecast improvements/developments with a baseline SRW forecast to evaluate the extent to which the contribution improves forecasting capabilities. Only one sample case is included in this PR, but others will be added subsequently.

Type of change

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

TESTS CONDUCTED:

None required. Built the docs for this branch of my fork on RTD: https://srw-ug.readthedocs.io/en/text-vxcases/ .

  • hera.intel
  • orion.intel
  • cheyenne.intel
  • cheyenne.gnu
  • gaea.intel
  • jet.intel
  • wcoss2.intel
  • NOAA Cloud (indicate which platform)

DEPENDENCIES:

N/A

DOCUMENTATION:

All documentation.

ISSUE:

Issue #499

CHECKLIST

  • My code follows the style guidelines in the Contributor's Guide
  • I have performed a self-review of my own code using the Code Reviewer's Guide
  • I have commented my code, particularly in hard-to-understand areas N/A
  • My changes need updates to the documentation. I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • New and existing tests pass with my changes
  • Any dependent changes have been merged and published N/A

CONTRIBUTORS (optional):

@natalie-perlin @EdwardSnyder-NOAA

@gspetro-NOAA gspetro-NOAA marked this pull request as ready for review November 30, 2022 19:43
Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

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

@gspetro-NOAA Excellent work! I have one minor comment regarding the section under Load the Regional Workflow, but otherwise, everything looks good.

docs/UsersGuide/source/VXCases.rst Show resolved Hide resolved
Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

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

@gspetro-NOAA Thanks! Now approving this PR.

@MichaelLueken MichaelLueken linked an issue Dec 1, 2022 that may be closed by this pull request
@gspetro-NOAA gspetro-NOAA added the DO_NOT_MERGE Ensure that a PR isn't merged label Dec 2, 2022
@gspetro-NOAA gspetro-NOAA removed the DO_NOT_MERGE Ensure that a PR isn't merged label Dec 2, 2022
@MichaelLueken
Copy link
Collaborator

@EdwardSnyder-NOAA Just wanted to check base and make sure that you are happy with the changes that @gspetro-NOAA has made in this PR. Please let @gspetro-NOAA know if there are any other changes that you would like for her to make. Thanks!

@MichaelLueken MichaelLueken merged commit 6d720f6 into ufs-community:develop Dec 2, 2022
@EdwardSnyder-NOAA
Copy link
Collaborator

LGTM! @MichaelLueken @gspetro-NOAA

@gspetro-NOAA gspetro-NOAA deleted the text/vxcases branch December 22, 2022 02:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sample Verification Cases
5 participants