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.

Sign up for GitHub

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

Jump to bottom

Update WM docs for SRW v3.0.0 release #2645

Open
wants to merge 9 commits into
base: release/public-v3.0.0
Choose a base branch
from
Open

Update WM docs for SRW v3.0.0 release #2645

wants to merge 9 commits into from

Conversation

gspetro-NOAA
Copy link
Collaborator

@gspetro-NOAA gspetro-NOAA commented Mar 12, 2025 •
edited
Loading

Commit Queue Requirements:

  • Fill out all sections of this template.
  • All sub component pull requests have been reviewed by their code managers.
  • Run the full Intel+GNU RT suite (compared to current baselines) on either Hera/Derecho/Hercules
  • Commit 'test_changes.list' from previous step N/A

Description:

This PR updates UFS WM documentation ahead of the SRW v3.0.0 release. It:

  • Updates the Build/Run chapter & the FAQ chapter
  • Updates documentation for controlling output frequency
  • Adds some FAQs from EPIC's website
  • Adds Frontera support
  • Removes RT Configurations chapter and adds relevant info to the Build/Run chapter. (The portion of that chapter related to specific tests is unmaintainable -- documentation must be pulled from docstrings or somehow automated; otherwise when tests are added, deleted, or modified, the documentation will immediately become out-of-date.)

RTs ran successfully on Hercules.

Commit Message:

* UFSWM - Update documentation, add Frontera support

Priority:

  • High: SRW v3.0.0 release

Git Tracking

UFSWM:

Sub component Pull Requests:

  • None

UFSWM Blocking Dependencies:

  • None

Changes

Regression Test Changes (Please commit test_changes.list):

  • No Baseline Changes.

Input data Changes:

  • None.

Library Changes/Upgrades:

  • No Updates

Testing Log:

  • RDHPCS
    • Hera
    • Orion
    • Hercules
    • GaeaC5
    • GaeaC6
    • Derecho
  • WCOSS2
    • Dogwood/Cactus
    • Acorn
  • CI
  • opnReqTest (complete task if unnecessary)

gspetro-NOAA
gspetro-NOAA commented Mar 12, 2025
View reviewed changes
doc/UsersGuide/source/FAQ.rst
The interval at which output (history) files are written is controlled in two
places, and depends on whether you are using the write component to generate your output files.
:numref:`Table %s <OutputControl>` describes the relevant variables. If the write_component is used, then the variables listed as ``model_configure`` are required. It is however, also required that the settings in ``input.nml`` match those same settings in ``model_configure``. If these settings are inconsistent, then unpredictable output files and intervals may occur!
The interval at which output (history) files are written is controlled via the ``model_configure*`` files.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@mkavulich Here is the FAQ update you requested; we'd like to add it to the WM release docs. Please let me know if there are any issues/corrections.

@gspetro-NOAA gspetro-NOAA marked this pull request as ready for review March 12, 2025 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@gspetro-NOAA