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 initial documentation for AQM #680

Merged
merged 23 commits into from
Mar 17, 2023

Conversation

gspetro-NOAA
Copy link
Collaborator

DESCRIPTION OF CHANGES:

This PR adds an AQM chapter to the develop branch documentation based on the information currently in our wiki.

Type of change

  • This change requires a documentation update

TESTS CONDUCTED:

None required. Docs can be viewed on my fork's RTD account: https://srw-ug.readthedocs.io/en/text-aqm/AQM.html
I ran through the steps on Hera, and everything up to the actual experiment worked, but since I can't use nems on Hera, the workflow failed.

  • 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:

This partially resolves Issue #625 . More thorough documentation is needed, but this is a start.

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 N/A

CONTRIBUTORS (optional):

@chan-hoo

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 Thank you very much for creating the initial documentation for AQM! This follows the wiki entry that @chan-hoo originally created here. Approving now.

@chan-hoo
Copy link
Collaborator

@gspetro-NOAA, I really appreciate your work for AQM !!!

Copy link
Collaborator

@mkavulich mkavulich 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 for giving me time to take a look, looks great!

@MichaelLueken
Copy link
Collaborator

@gspetro-NOAA Thanks for making the adjustments for WCOSS2!

@chan-hoo If this looks good to you, I will go ahead and get this PR merged!

@chan-hoo
Copy link
Collaborator

@MichaelLueken, it looks good to me. Please go ahead.

@MichaelLueken MichaelLueken merged commit f250f1b into ufs-community:develop Mar 17, 2023
@gspetro-NOAA gspetro-NOAA deleted the text/aqm branch January 30, 2024 18:23
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.

5 participants