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]: Adding in the tutorial for the Halloween Storm #1124

Merged
merged 63 commits into from
Oct 10, 2024

Conversation

jdkublnick
Copy link
Collaborator

@jdkublnick jdkublnick commented Aug 28, 2024

DESCRIPTION OF CHANGES:

This PR adds a tutorial to the Tutorials chapter of the SRW App User's Guide. It is based off the Halloween Storm UFS case study.

Type of change

  • [ X] This change requires a documentation update

TESTS CONDUCTED:

None required.

DEPENDENCIES:

None

DOCUMENTATION:

Build on RTD: https://ufs-srweather-app-joshua-kublnick.readthedocs.io/en/text-us-216/UsersGuide/index.html

ISSUE:

Addresses issue #1123

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
  • My changes need updates to the documentation. I have made corresponding changes to the documentation
  • My changes do not require updates to the documentation (explain).
  • My changes generate no new warnings
  • New and existing tests pass with my changes
  • Any dependent changes have been merged and published

LABELS (optional):

A Code Manager needs to add the following labels to this PR:

  • [ X] documentation

CONTRIBUTORS (optional):

@MichaelLueken MichaelLueken added the documentation Improvements or additions to documentation label Aug 28, 2024
@MichaelLueken MichaelLueken linked an issue Aug 28, 2024 that may be closed by this pull request
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.

@jdkublnick -

I've noted two minor spelling/grammatical issues in my review. Also, I noticed the comment regarding QUILTING. QUILTING is required for regional grids and is set to true by default in config_defaults.yaml. Additionally, the config.community.yaml file already has QUILTING: true set for task_run_fcst:, so you should be fine with not modifying the task_run_fcst: section for the tutorial.

doc/UsersGuide/BuildingRunningTesting/Tutorial.rst Outdated Show resolved Hide resolved
doc/UsersGuide/BuildingRunningTesting/Tutorial.rst Outdated 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.

Thanks for making my recommended changes, @jdkublnick! Approving now.

@MichaelLueken MichaelLueken merged commit 3e9c40a into ufs-community:develop Oct 10, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Tutorial section of Users Guide
3 participants