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 SRW-SD chapter to SRW App docs #1128

Merged
merged 30 commits into from
Nov 25, 2024

Conversation

gspetro-NOAA
Copy link
Collaborator

DESCRIPTION OF CHANGES:

Adds documentation for the RRFS-SD features added to PR #1127 .

Type of change

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

TESTS CONDUCTED:

None required. Documentation builds on RTD (see check below). Ran the workflow on Hera using the instructions in these docs.

DEPENDENCIES:

PR #1127

DOCUMENTATION:

All documentation.

ISSUE:

Issue #1126

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

CONTRIBUTORS (optional):

@chan-hoo

@MichaelLueken MichaelLueken added the documentation Improvements or additions to documentation label Sep 11, 2024
@MichaelLueken MichaelLueken linked an issue Sep 11, 2024 that may be closed by this pull request
@gspetro-NOAA gspetro-NOAA changed the title [develop]: Add RRFS-SD chapter to SRW App docs [develop]: Add SRW-SD chapter to SRW App docs Nov 1, 2024
Co-authored-by: BenKoziol-NOAA <bkoziol@redlineperf.com>
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 -

These changes look good to me! I was wondering whether the word sample should be changed to simple (as noted in my review), but that's the only comment I have.

doc/UsersGuide/BuildingRunningTesting/SRW-SD.rst Outdated Show resolved Hide resolved
gspetro-NOAA and others added 2 commits November 25, 2024 15:31
Co-authored-by: BenKoziol-NOAA <bkoziol@redlineperf.com>
Co-authored-by: Michael Lueken <63728921+MichaelLueken@users.noreply.github.com>
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, @gspetro-NOAA!

@MichaelLueken MichaelLueken merged commit dfb8fd3 into ufs-community:develop Nov 25, 2024
3 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.

Need to add smoke and dust capability
4 participants